AtlasAI Data API V1

Base URL: data.atlasai.co/api/v1/, Version: 1.1.0, Learn more about AtlasAI here

This API allows users to download data created by AtlasAI

Schemes: https

Summary

Tag: Categories

Groups of like indicators

Operation Description
GET /categories

Lists all published dataset categories

GET /categories/{id}

Find category by ID

Tag: Time Periods

Range of time for a given dataset

Operation Description
GET /time-periods

Lists all dataset time periods

GET /time-periods/{id}

Find a time period by ID

Tag: Indicators

Collections of datasets by topic

Operation Description
GET /indicators

Lists all published dataset indicators

GET /indicators/{id}

Find indicator by ID

Tag: Dataset Files

Individual raster and vector files, and their metadata

Operation Description

Tag: Users

Authentication and information for your account

Find out more about our Atlas AI

Operation Description
POST /reset-api-key

Resets API Key for a given user

POST /validate-user

Tag: General

General information about the server

Operation Description
GET /health

Tests the health of the server

Tag: User

Operation Description
GET /validate-api-key

Verifies validity of existing API key

POST /register

Registers new users

POST /request-password-reset

Request user password reset

POST /reset-password

Resets a user's password

POST /authenticate

Authenticates user and returns API Key

Tag: Aggregation Levels

Operation Description
GET /aggregation-levels

Lists all published dataset aggregation levels

GET /aggregation-levels/{id}

Find aggregation level by ID

Tag: Datasets

Operation Description
GET /datasets

Lists all available datasets for a given user

GET /datasets/{id}

Find dataset by ID

POST /datasets/{id}/extract

Extract a dataset by bounding box

Security

api_key

Type: apiKey
Name:

token

In:

header

Paths

Lists all published dataset aggregation levels

GET /aggregation-levels

Tags: Aggregation Levels

application/json

application/json

200 OK

successful operation

api_key
Find aggregation level by ID

GET /aggregation-levels/{id}

Tags: Aggregation Levels

Returns a single aggregation level

id

ID of aggregation level to return

path integer (int64)

application/json

200 OK

successful operation

400 Bad Request

Invalid ID supplied

404 Not Found

Aggregation Level not found

api_key
Authenticates user and returns API Key

POST /authenticate

Tags: User

application/json

email

The email for login

query string
password

The password for login in clear text

query string

application/json

200 OK

successful operation

400 Bad Request

Bad password

404 Not Found

User not found

Lists all published dataset categories

GET /categories

Tags: Categories

application/json

application/json

200 OK

successful operation

api_key
Find category by ID

GET /categories/{id}

Tags: Categories

Returns a single category

id

ID of category to return

path integer (int64)

application/json

200 OK

successful operation

400 Bad Request

Invalid ID supplied

404 Not Found

Category not found

api_key
Lists all available datasets for a given user

GET /datasets

Tags: Datasets

application/json

aggregationLevelId

ID of aggregation level to filter by

query integer (int64)
indicatorId

ID of indicator to filter by

query integer (int64)

application/json

200 OK

successful operation

api_key
Find dataset by ID

GET /datasets/{id}

Tags: Datasets

Returns a single dataset

id

ID of dataset to return

path integer (int64)

application/json

200 OK

successful operation

400 Bad Request

Invalid ID supplied

401 Unauthorized

Unauthorized

404 Not Found

Dataset not found

api_key
Extract a dataset by bounding box

POST /datasets/{id}/extract

Tags: Datasets

Returns a status, and prepares data to send via email

id

ID of dataset to extract

path integer (int64)
y_min

The minimum latitude of the bounds in decimal degrees

formData float
y_max

The maximum latitude of the bounds in decimal degrees

formData float
x_min

The minimum longitude of the bounds in decimal degrees

formData float
x_max

The maximum longitude of the bounds in decimal degrees

formData float

200 OK

Download queued. Please check your email for download instructions

400 Bad Request
422 Unprocessable Entity

Incorrect parameters

Tests the health of the server

GET /health

Tags: General
200 OK

Server is up and running 🌍

Lists all published dataset indicators

GET /indicators

Tags: Indicators

application/json

application/json

200 OK

successful operation

api_key
Find indicator by ID

GET /indicators/{id}

Tags: Indicators

Returns a single indicator

id

ID of indicator to return

path integer (int64)

application/json

200 OK

successful operation

400 Bad Request

Invalid ID supplied

404 Not Found

Indicator not found

api_key
Registers new users

POST /register

Tags: User

application/x-www-form-urlencoded

email

The email for login

formData string
password

The password for login in clear text

formData string
name

The name of the user. Used for communication

formData string

application/json

200 OK

successful operation

400 Bad Request

Issues with parameters or duplicate emails

404 Not Found

User not found

Request user password reset

POST /request-password-reset

Tags: User

application/x-www-form-urlencoded

email

The email address of the user requesting a password reset

formData string
200 OK

Operation complete. An email will be sent to the email if one of a valid valid account is selected

400 Bad Request

Missing parameter email

Resets API Key for a given user

POST /reset-api-key

Tags: Users

application/x-www-form-urlencoded

token

Confirmation of the token in use

formData string
email

email address the token belongs to

formData string

application/json

200 OK

successful operation

Resets a user's password

POST /reset-password

Tags: User

application/x-www-form-urlencoded

password

The password for login in clear text

formData string
token

The password reset token sent to the user by the request-password-reset endpoint

formData string
200 OK

Password reset

400 Bad Request

Invalid parameters

Lists all dataset time periods

GET /time-periods

Tags: Time Periods

Returns a list of time periods

application/json

application/json

200 OK

successful operation

api_key
Find a time period by ID

GET /time-periods/{id}

Tags: Time Periods

Returns a single time period

id

ID of time period to return

path integer (int64)

application/json

200 OK

successful operation

400 Bad Request

Invalid ID supplied

404 Not Found

Time period not found

api_key
Verifies validity of existing API key

GET /validate-api-key

Tags: User
token

The API key in use

query string
email

The email of the current user

query string

application/json

200 OK

API Token is Valid

400 Bad Request

API Token is not valid

POST /validate-user

Tags: Users

Validates a user account to the base validated level

application/json

token

Token provided to the user through the welcome/confirmation email

query string
email

The email address of the user account

query string

application/json

200 OK

successful operation

400 Bad Request

Invalid token

Schema definitions

AggregationLevel: object

A level of display for an indicator

id: integer (int64)
name: string
description: string

ApiResponse: object

code: integer (int32)
type: string
message: string

Category: object

What groups like indicators

id: integer (int64)
name: string
iconifyIcon: string

Dataset: object

Fetching data about an indicator at an aggregation level at a specific time

id: integer (int64)
dataType: string

Either "vector" or "raster"

datasetAggregationLevelId: integer (int64)
indicator: string
aggregationLevel: string
displayOrder: integer (int64)
datasetIndicatorId: integer (int64)
indicatorId: integer (int64)
timePeriodId: integer (int64)
rasterAggregationLevel: string

Corresponds to the aggregation level at which the raster is tiled and mosaicked for download

maxDlSizeKmsq: integer (int64)

The size of the maximum bounding box for the extraction tool

layerExtent: string

The geometry of the layer's bounding box

version: string
timePeriod: string
available: boolean
mapboxSource: string
mapboxStyle: string

DatasetFile: object

geometryId: string
aggregationLevel: string
indicator: string
datasetId: integer (int32)
version: string

Indicator: object

A series of datasets pertaining to a single topic

id: integer (int64)
name: string
legendType: string
legendUnits: string
description: string
documentationUrl: string
datasetCategoryID: integer (int64)
previewThumbnailUrl: string
available: boolean

User: object

User accounts

name: string
email: string
token: string

the API token for use with that account