NAV Navigation
Python

Radiant MLHub API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Web: Radiant Earth Foundation

Authentication

An API key can be acquired by registering on the MLHub Dashboard

All API requests must be made with the key query parameter present.

Default

collections

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.radiant.earth/mlhub/v1/collections', headers = headers)

print(r.json())

GET /collections

A list of collections

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none Json

collectionArchiveDownload

Code samples

import requests

r = requests.get('https://api.radiant.earth/mlhub/v1/archive/{collection_id}')

print(r.json())

GET /archive/{collection_id}

Returns a redirect to the archived collection

Parameters

Name In Type Required Description
collection_id path string true none

Responses

Status Meaning Description Schema
302 Found Redirect to Archive Download None

Response Headers

Status Header Type Format Description
302 Location undefined none

collectionUnique

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.radiant.earth/mlhub/v1/collections/{p1}', headers = headers)

print(r.json())

GET /collections/{p1}

A single collection

Parameters

Name In Type Required Description
p1 path string true none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none Json
404 Not Found not found NotFound

collectionItems

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.radiant.earth/mlhub/v1/collections/{p1}/items', headers = headers)

print(r.json())

GET /collections/{p1}/items

A feature collection of collection items

Parameters

Name In Type Required Description
p1 path string true none
next query string false Opaque token to retrieve the next page of items
limit query integer false How many items to return. Defaults to 30
extensions query array[string] false Return only items with listed supported extensions

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none Json

collectionItemUnique

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.radiant.earth/mlhub/v1/collections/{p1}/items/{p2}', headers = headers)

print(r.json())

GET /collections/{p1}/items/{p2}

A single feature

Parameters

Name In Type Required Description
p1 path string true none
p2 path string true none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none Json
404 Not Found not found NotFound

Response Headers

Status Header Type Format Description
200 ETag string none

search-get

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.radiant.earth/mlhub/v1/search', headers = headers)

print(r.json())

GET /search

Search endpoint for all collections

Parameters

Name In Type Required Description
datetime query string false none
bbox query string false none
collections query string false none
ids query string false none
limit query integer false none
next query string false none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none Json

search-post

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.radiant.earth/mlhub/v1/search', headers = headers)

print(r.json())

POST /search

Search endpoint using POST for all collections

Body parameter

{
  "bbox": {
    "xmin": 0,
    "ymin": 0,
    "zmin": 0,
    "xmax": 0,
    "ymax": 0,
    "zmax": 0
  },
  "datetime": null,
  "intersects": null,
  "collections": [
    "string"
  ],
  "items": [
    "string"
  ],
  "limit": 0,
  "query": {
    "property1": [
      {
        "substring": "string"
      }
    ],
    "property2": [
      {
        "substring": "string"
      }
    ]
  },
  "next": {
    "timestampAtLeast": "2019-08-24T14:15:22Z",
    "serialIdGreaterThan": 0
  }
}

Parameters

Name In Type Required Description
next query string false none
body body SearchFilters true none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none Json

Schemas

Conformance

{
  "conformsTo": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
conformsTo [string] false none none

LandingPage

{
  "title": "string",
  "description": "string",
  "links": [
    {
      "href": "string",
      "rel": {},
      "_type": {
        "underlying": "string"
      },
      "title": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
title string true none none
description string true none none
links [Link] false none none 
{
  "href": "string",
  "rel": {},
  "_type": {
    "underlying": "string"
  },
  "title": "string"
}

Properties

Name Type Required Restrictions Description
href string true none none
rel StacLinkType true none none
_type StacMediaType false none none
title string false none none

StacLinkType

{}

Properties

oneOf

Name Type Required Restrictions Description
anonymous Alternate false none none

xor

Name Type Required Restrictions Description
anonymous Child false none none

xor

Name Type Required Restrictions Description
anonymous Collection false none none

xor

Name Type Required Restrictions Description
anonymous Conformance1 false none none

xor

Name Type Required Restrictions Description
anonymous Data false none none

xor

Name Type Required Restrictions Description
anonymous DerivedFrom false none none

xor

Name Type Required Restrictions Description
anonymous DescribedBy false none none

xor

Name Type Required Restrictions Description
anonymous Item false none none

xor

Name Type Required Restrictions Description
anonymous Items false none none

xor

Name Type Required Restrictions Description
anonymous LatestVersion false none none

xor

Name Type Required Restrictions Description
anonymous License false none none

xor

Name Type Required Restrictions Description
anonymous Next false none none

xor

Name Type Required Restrictions Description
anonymous Parent false none none

xor

Name Type Required Restrictions Description
anonymous PredecessorVersion false none none

xor

Name Type Required Restrictions Description
anonymous Prev false none none

xor

Name Type Required Restrictions Description
anonymous Self false none none

xor

Name Type Required Restrictions Description
anonymous ServiceDesc false none none

xor

Name Type Required Restrictions Description
anonymous ServiceDoc false none none

xor

Name Type Required Restrictions Description
anonymous Source false none none

xor

Name Type Required Restrictions Description
anonymous StacRoot false none none

xor

Name Type Required Restrictions Description
anonymous SuccessorVersion false none none

xor

Name Type Required Restrictions Description
anonymous VendorLinkType false none none

Alternate

{}

Properties

None

Child

{}

Properties

None

Collection

{}

Properties

None

Conformance1

{}

Properties

None

Data

{}

Properties

None

DerivedFrom

{}

Properties

None

DescribedBy

{}

Properties

None

Item

{}

Properties

None

Items

{}

Properties

None

LatestVersion

{}

Properties

None

License

{}

Properties

None

Next

{}

Properties

None

Parent

{}

Properties

None

PredecessorVersion

{}

Properties

None

Prev

{}

Properties

None

Self

{}

Properties

None

ServiceDesc

{}

Properties

None

ServiceDoc

{}

Properties

None

Source

{}

Properties

None

StacRoot

{}

Properties

None

SuccessorVersion

{}

Properties

None

VendorLinkType

{
  "underlying": "string"
}

Properties

Name Type Required Restrictions Description
underlying string true none none

StacMediaType

{
  "underlying": "string"
}

Properties

oneOf

Name Type Required Restrictions Description
anonymous VendorMediaType false none none

xor

Name Type Required Restrictions Description
anonymous application/geo+json false none none

xor

Name Type Required Restrictions Description
anonymous application/geopackage+sqlite3 false none none

xor

Name Type Required Restrictions Description
anonymous application/json false none none

xor

Name Type Required Restrictions Description
anonymous application/x-hdf false none none

xor

Name Type Required Restrictions Description
anonymous application/x-hdf5 false none none

xor

Name Type Required Restrictions Description
anonymous application/xml false none none

xor

Name Type Required Restrictions Description
anonymous image/cog false none none

xor

Name Type Required Restrictions Description
anonymous image/geotiff false none none

xor

Name Type Required Restrictions Description
anonymous image/jp2 false none none

xor

Name Type Required Restrictions Description
anonymous image/jpeg false none none

xor

Name Type Required Restrictions Description
anonymous image/png false none none

xor

Name Type Required Restrictions Description
anonymous text/html false none none

xor

Name Type Required Restrictions Description
anonymous text/plain false none none

xor

Name Type Required Restrictions Description
anonymous text/xml false none none

VendorMediaType

{
  "underlying": "string"
}

Properties

Name Type Required Restrictions Description
underlying string true none none

application/geo+json

{}

Properties

None

application/geopackage+sqlite3

{}

Properties

None

application/json

{}

Properties

None

application/x-hdf

{}

Properties

None

application/x-hdf5

{}

Properties

None

application/xml

{}

Properties

None

image/cog

{}

Properties

None

image/geotiff

{}

Properties

None

image/jp2

{}

Properties

None

image/jpeg

{}

Properties

None

image/png

{}

Properties

None

text/html

{}

Properties

None

text/plain

{}

Properties

None

text/xml

{}

Properties

None

Json

null

Properties

None

NotFound

{
  "msg": "string"
}

Properties

Name Type Required Restrictions Description
msg string true none none

SearchFilters

{
  "bbox": {
    "xmin": 0,
    "ymin": 0,
    "zmin": 0,
    "xmax": 0,
    "ymax": 0,
    "zmax": 0
  },
  "datetime": null,
  "intersects": null,
  "collections": [
    "string"
  ],
  "items": [
    "string"
  ],
  "limit": 0,
  "query": {
    "property1": [
      {
        "substring": "string"
      }
    ],
    "property2": [
      {
        "substring": "string"
      }
    ]
  },
  "next": {
    "timestampAtLeast": "2019-08-24T14:15:22Z",
    "serialIdGreaterThan": 0
  }
}

Properties

Name Type Required Restrictions Description
bbox Bbox false none none
datetime Json false none none
intersects Json false none none
collections [string] false none none
items [string] false none none
limit integer false none none
query Map_List_Query true none none
next PaginationToken false none none

Bbox

{
  "xmin": 0,
  "ymin": 0,
  "zmin": 0,
  "xmax": 0,
  "ymax": 0,
  "zmax": 0
}

Properties

oneOf

Name Type Required Restrictions Description
anonymous ThreeDimBbox false none none

xor

Name Type Required Restrictions Description
anonymous TwoDimBbox false none none

ThreeDimBbox

{
  "xmin": 0,
  "ymin": 0,
  "zmin": 0,
  "xmax": 0,
  "ymax": 0,
  "zmax": 0
}

Properties

Name Type Required Restrictions Description
xmin number(double) true none none
ymin number(double) true none none
zmin number(double) true none none
xmax number(double) true none none
ymax number(double) true none none
zmax number(double) true none none

TwoDimBbox

{
  "xmin": 0,
  "ymin": 0,
  "xmax": 0,
  "ymax": 0
}

Properties

Name Type Required Restrictions Description
xmin number(double) true none none
ymin number(double) true none none
xmax number(double) true none none
ymax number(double) true none none

Map_List_Query

{
  "property1": [
    {
      "substring": "string"
    }
  ],
  "property2": [
    {
      "substring": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
additionalProperties [Query] false none none

Query

{
  "substring": "string"
}

Properties

oneOf

Name Type Required Restrictions Description
anonymous Contains false none none

xor

Name Type Required Restrictions Description
anonymous EndsWith false none none

xor

Name Type Required Restrictions Description
anonymous Equals false none none

xor

Name Type Required Restrictions Description
anonymous GreaterThan false none none

xor

Name Type Required Restrictions Description
anonymous GreaterThanEqual false none none

xor

Name Type Required Restrictions Description
anonymous In false none none

xor

Name Type Required Restrictions Description
anonymous LessThan false none none

xor

Name Type Required Restrictions Description
anonymous LessThanEqual false none none

xor

Name Type Required Restrictions Description
anonymous NotEqualTo false none none

xor

Name Type Required Restrictions Description
anonymous StartsWith false none none

xor

Name Type Required Restrictions Description
anonymous Superset false none none

Contains

{
  "substring": "string"
}

Properties

Name Type Required Restrictions Description
substring string true none none

EndsWith

{
  "postfix": "string"
}

Properties

Name Type Required Restrictions Description
postfix string true none none

Equals

{
  "value": null
}

Properties

Name Type Required Restrictions Description
value Json true none none

GreaterThan

{
  "floor": null
}

Properties

Name Type Required Restrictions Description
floor Json true none none

GreaterThanEqual

{
  "floor": null
}

Properties

Name Type Required Restrictions Description
floor Json true none none

In

{
  "values": [
    null
  ]
}

Properties

Name Type Required Restrictions Description
values [Json] true none none

LessThan

{
  "ceiling": null
}

Properties

Name Type Required Restrictions Description
ceiling Json true none none

LessThanEqual

{
  "ceiling": null
}

Properties

Name Type Required Restrictions Description
ceiling Json true none none

NotEqualTo

{
  "value": null
}

Properties

Name Type Required Restrictions Description
value Json true none none

StartsWith

{
  "prefix": "string"
}

Properties

Name Type Required Restrictions Description
prefix string true none none

Superset

{
  "values": [
    null
  ]
}

Properties

Name Type Required Restrictions Description
values [Json] true none none

PaginationToken

{
  "timestampAtLeast": "2019-08-24T14:15:22Z",
  "serialIdGreaterThan": 0
}

Properties

Name Type Required Restrictions Description
timestampAtLeast string(date-time) true none none
serialIdGreaterThan integer true none none
Python