Skip to main content
API docs by Redocly

Distribution API (0.1.0)

Download OpenAPI specification:Download

World from Space: orbis@worldfrom.space URL: https://worldfrom.space/services/orbis/

Ingestion API adheres to the STAC (SpatioTemporal Asset Catalog) standard and its extensions, which allows for discovery, search and retrieval of Orbis Earth Observation data products. Read more about accessing Orbis data products."

Core

Landing Page

Returns the root STAC Catalog or STAC Collection, which is the entry point for users to browse with STAC Browser or for search engines to crawl.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "stac_version": "string",
  • "links": [
    ],
  • "stac_extensions": [
    ],
  • "title": "string",
  • "type": "string",
  • "conformsTo": [
    ]
}

Conformance

A list of all the conformance classes specified in a STAC service that the server conforms to.

Responses

Response samples

Content type
application/json
{
  • "conformsTo": [
    ]
}

Collections

All Collections By Instrument Id

Provides information about the Collections available in the catalog. Each collection represents a group of STAC Items, which share common metadata.

Responses

Response samples

Content type
application/json
{
  • "collections": [
    ],
  • "links": [
    ]
}

Collection By Id

To get detailed information about a specific collection.

path Parameters
collection_id
required
string (Collection Id)

The unique ID of the collection

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "stac_version": "string",
  • "links": [
    ],
  • "stac_extensions": [
    ],
  • "title": "string",
  • "type": "string",
  • "license": "string",
  • "extent": {
    },
  • "keywords": [
    ],
  • "providers": [
    ],
  • "summaries": {
    }
}

Features

Item Collection

Retrieves STAC Items that belong to a specific collection. STAC Items are the most fundamental objects in a STAC API, representing a spatiotemporal asset

path Parameters
collection_id
required
string (Collection Id)

The unique ID of the collection

query Parameters
Bbox (string) or Bbox (null) (Bbox)

Attribute bbox will list all products from a given collection within the Area of Interest (AOI). This attribute requires between 4 and 6 values (coordinates) where a comma separates each coordinate.

Datetime (string) or Datetime (null) (Datetime)

Attribute datetime will list all products within a specified time interval. It can search for several different formats:

2022-12-31T00:00:00Z

2022-12-31T00:00:00

2022-12-31T16:00:00-08:00

2022-12-31T00:00:00+01:00

2022-12-31T00:00:00.000Z

2022-12-31T00:00:00.000



For datetime intervals:

  • /2021-12-31T23:59:59Z (open start interval)
  • 2021-12-31T23:59:59Z/ (open end interval)
  • 2022-12-30T00:00:00Z/2022-12-31T23:59:59Z (closed interval)
Sortby (string) or Sortby (null) (Sortby)

The sortby option allows users to define the fields by which to sort results.

Several attributes to sort by can be provided delimited by a comma. To set the sort order, the prefix should be added to the sort parameter:

  • + for ascending (in https standard + sign should be encoded with %2B)
  • - for descending If no prefix is provided, ascending order is assumed.
page
integer (Page) [ 1 .. 100 ]
Default: 1

The page option determines the page of results.

The acceptable arguments for this option: Integer <1,100>

limit
integer (Limit) [ 1 .. 10000 ]
Default: 10

The limit option allows users to increase or decrease the number of items shown.

The default value is set to 10.

The acceptable arguments for this option: Integer <0,10000>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "features": [
    ],
  • "links": [
    ],
  • "numberMatched": 0,
  • "numberReturned": 0
}

Item By Id

This provides information about a specific STAC Item and its assets.

path Parameters
collection_id
required
string (Collection Id)

The unique ID of the collection

feature_id
required
string (Feature Id)

The ID of the feature to get

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "stac_version": "string",
  • "stac_extensions": [
    ],
  • "geometry": {
    },
  • "bbox": [
    ],
  • "datetime": "2019-08-24T14:15:22Z",
  • "properties": { },
  • "links": [
    ],
  • "assets": {
    },
  • "collection": "string"
}

Get Search

Listing by attributes and using the pagination and limit option

query Parameters
Collections (string) or Collections (null) (Collections)

Comma separated list of collection ids to get

Ids (string) or Ids (null) (Ids)

Comma separated list of feature ids to get

Bbox (string) or Bbox (null) (Bbox)

Attribute bbox will list all products from a given collection within the Area of Interest (AOI). This attribute requires between 4 and 6 values (coordinates) where a comma separates each coordinate.

Datetime (string) or Datetime (null) (Datetime)

Attribute datetime will list all products within a specified time interval. It can search for several different formats:

2022-12-31T00:00:00Z

2022-12-31T00:00:00

2022-12-31T16:00:00-08:00

2022-12-31T00:00:00+01:00

2022-12-31T00:00:00.000Z

2022-12-31T00:00:00.000



For datetime intervals:

  • /2021-12-31T23:59:59Z (open start interval)
  • 2021-12-31T23:59:59Z/ (open end interval)
  • 2022-12-30T00:00:00Z/2022-12-31T23:59:59Z (closed interval)
Sortby (string) or Sortby (null) (Sortby)

The sortby option allows users to define the fields by which to sort results.

Several attributes to sort by can be provided delimited by a comma. To set the sort order, the prefix should be added to the sort parameter:

  • + for ascending (in https standard + sign should be encoded with %2B)
  • - for descending If no prefix is provided, ascending order is assumed.
page
integer (Page) [ 1 .. 100 ]
Default: 1

The page option determines the page of results.

The acceptable arguments for this option: Integer <1,100>

limit
integer (Limit) [ 1 .. 10000 ]
Default: 10

The limit option allows users to increase or decrease the number of items shown.

The default value is set to 10.

The acceptable arguments for this option: Integer <0,10000>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "features": [
    ],
  • "links": [
    ],
  • "numberMatched": 0,
  • "numberReturned": 0
}

Post Search

Conducts a full-text search for STAC Items across all collections and returns a catalog of STAC Items that match the search criteria.

query Parameters
page
integer (Page) [ 1 .. 100 ]
Default: 1

The page option determines the page of results.

The acceptable arguments for this option: Integer <1,100>

Request Body schema: application/json
required
Array of Collections (strings) or Collections (null) (Collections)
Array of Ids (strings) or Ids (null) (Ids)
Array of Bbox (items) or Array of Bbox (items) or Bbox (null) (Bbox)
Intersects (any) or Intersects (null) (Intersects)
Datetime (string) or Datetime (null) (Datetime)
limit
integer (Limit) [ 1 .. 10000 ]
Default: 10
Query (object) or Query (null) (Query)
Array of Sortby (objects) or Sortby (null) (Sortby)

Responses

Request samples

Content type
application/json
{
  • "collections": [
    ],
  • "ids": [
    ],
  • "bbox": [
    ],
  • "intersects": {
    },
  • "datetime": "string",
  • "limit": 10,
  • "query": {
    },
  • "sortby": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "features": [
    ],
  • "links": [
    ],
  • "numberMatched": 0,
  • "numberReturned": 0
}