Getting started with data.world API

The following instructions help you set up your data.world account and interact with our API, including sending your first API request. Every call of the data.world API requires an API Token. After you create an account in data.world, we generate three supported token levels.

Step 1: Create an Account or sign in

  1. Go to data.world Sign-up page.
  2. Enter your email address, name, username, and password.
  3. Select Continue.

🚧

Already registered?

If you already have an account, go to the data.world Sign-in page and enter your credentials to access the account.

Step 2: Get the Tokens

  1. Select your profile in the upper right corner.
  2. In the user menu, select Settings.
  3. In the left navigation pane of the settings page, select Advanced.
  4. Under the API Tokens, you will see your tokens listed.

advanced-settings

📘

Note

Treat your tokens like passwords. For security, do not share them or store them in unsafe places.

Step 3: Send your first API request

The data.world API allows you to interact with our system directly from your web browser interface. Here is how you can create a dataset using this interactive API:

  1. Go to the Create a dataset endpoint.
  2. In the Authorization section, in the OAuth2 field, enter the Read/Write API Token next to the Bearer label. For example, the value will look like Bearer eyJhbGciOiJIUzUxMiJ9.
  3. Next, in the Path params, enter the owner parameter, where the owner is your user account ID or organization ID.
  4. In the Body params section, you can use the provided form fields to add content like title (required), description, tags, visibility settings, and license designation. You can also choose to modify the request directly in the Request preview section.
  5. Click Try it! to send your request.
  6. If everything is correctly done, you will receive a response with 200 OK status. Copy the provided URI from the Response section to check out your newly created dataset.

send-api-request

📘

Note

If you do not get a response or encounter an error, check your internet connection and make sure the token is correct. The API reference provides several helper options to generate example requests for shell commands, Python requests, and more.