api  ·  platform  ·  guides
API Documentation

Getting Started

Obtaining a Token


Error Messages


GET users/:username

GET users/:username/followers

GET users/:username/following

GET users/:username/hubs

GET users/:username/projects


GET hubs/:uniquename

GET hubs/:uniquename/followers

GET hubs/:uniquename/members

GET hubs/:uniquename/projects


GET projects/:id

GET projects/:id/files

GET projects/:id/contributors

GET projects/:id/activity


GET files/:id

GET files/:id/data

GET files/:id/map

GET files/:id/search

GET files/:id/filter

POST files/

PATCH files/:id


Getting Started

Welcome to the Datazar API!
The API allows you to access any object data and any dataset.
You can use the API to either build external applications or stream the datasets directly. Please refer to the object specific documentation to know exactly how to obtain the information. All API requests require a token. The API follows the Basic Authentication mechanism. Please read below to obtain an access token.

Obtaining a Token

To obtain an access token, you'll need a Datazar account. Please navigate to to signup. How to guides on how to sign up can be found here.

Once you have created your account, click on your profile image on the top bar. A menu will appear and then click on "Settings".

When you're on the "Settings" page, use the navigation tabs to go to "Tokens".

To create a new token, click on the "Create New Token" button. That will trigger a popup and you'll be prompted to enter a token name (required). Token names will help you organize your tokens. Click "Create Token".

The popup will then show you the "Token Secret". Use the "copy" button right next to it to copy the text. Please do not share this token. Once you have copied the text, check the checkbox below the text to confirm you have copied it. The "Token Secret" will not appear again after you confirm the checkbox. That's it, you're all done! Enjoy the API.


Libraries for the API can be found here.

· Node
· Python
· Mathematica
· R

Error Messages

Error messages will be thrown if the authentication key is wrong, object does not exist or if they authenticated user does not have permission.

  "message": "authentication failed",