Queries

Raster Pixel Info

get

Get a single pixel value at a given location.

Path parameters

dataset_version_idstringRequired

UUID of the dataset version to query. Each dataset can have multiple versions representing different states of the data over time

lonnumberRequired

Longitude in decimal degrees (-180 to 180, WGS84/EPSG:4326)

latnumberRequired

Latitude in decimal degrees (-90 to 90, WGS84/EPSG:4326)

Query parameters

api_keystringRequired

Earthscale API key used to authenticate requests and determine which datasets you have access to. API keys can be managed in the Earthscale Web App under the user menu (top-right) -> 'API Settings'

variablestringRequired

Name of the data variable/band to retrieve from the dataset (e.g., 'temperature', 'B4', 'elevation')

zoomany ofOptional

Map zoom level for fuzzy coordinate matching. When specified, searches within a pixel-sized radius around the coordinates to handle click imprecision. If omitted, returns only exact coordinate matches

integerOptional

or

nullOptional

dimidxany ofOptional

Select a slice from multi-dimensional datasets (e.g., with time or depth axes). Format: 'dimension:index' where index is zero-based. Example: 'time:0' selects the first timestep, 'depth:5' selects the 6th depth level. Repeat for multiple dimensions: ?dimidx=time:0&dimidx=depth:2. All extra dimensions of the dataset must be specified to select a single value

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/raster/{dataset_version_id}/pixels/{lon}/{lat}

HTTPcURLJavaScriptPython

GET /v1/raster/{dataset_version_id}/pixels/{lon}/{lat}?api_key=text&variable=text HTTP/1.1
Accept: */*

{
  "dimension_selection": {
    "time": 0
  },
  "value": 23.5
}

Raster Pixel Info Series

get

Get all pixel values for a given dimension and location.

Path parameters

dataset_version_idstringRequired

UUID of the dataset version to query. Each dataset can have multiple versions representing different states of the data over time

lonnumberRequired

Longitude in decimal degrees (-180 to 180, WGS84/EPSG:4326)

latnumberRequired

Latitude in decimal degrees (-90 to 90, WGS84/EPSG:4326)

dimstringRequired

Name of the dimension to retrieve all values for (e.g., 'time'). Returns a time series or similar array of values at the given location. The dimension must be indexed in the dataset; use dimidx to fix other dimensions

Query parameters

api_keystringRequired

Earthscale API key used to authenticate requests and determine which datasets you have access to. API keys can be managed in the Earthscale Web App under the user menu (top-right) -> 'API Settings'

variablestringRequired

Name of the data variable/band to retrieve from the dataset (e.g., 'temperature', 'B4', 'elevation')

zoomany ofOptional

Map zoom level for fuzzy coordinate matching. When specified, searches within a pixel-sized radius around the coordinates to handle click imprecision. If omitted, returns only exact coordinate matches

integerOptional

or

nullOptional

pageintegerOptional

Zero-based page number for paginated results. Each page returns up to 500 items

Default: 0

dimidxany ofOptional

Select a slice from multi-dimensional datasets (e.g., with time or depth axes). Format: 'dimension:index' where index is zero-based. Example: 'time:0' selects the first timestep, 'depth:5' selects the 6th depth level. Repeat for multiple dimensions: ?dimidx=time:0&dimidx=depth:2. Specify all dimensions except the one in the URL path (dim parameter), which will be iterated over to return a series of values

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/raster/{dataset_version_id}/pixels/{lon}/{lat}/{dim}

HTTPcURLJavaScriptPython

GET /v1/raster/{dataset_version_id}/pixels/{lon}/{lat}/{dim}?api_key=text&variable=text HTTP/1.1
Accept: */*

{
  "dimension": "time",
  "dimension_selection": {
    "depth": 0
  },
  "page_size": 500,
  "values": [
    23.5,
    24.1,
    22.8,
    25,
    null,
    23.2
  ]
}

Vector Point Query

get

Get vector features at a given location.

Path parameters

dataset_version_idstringRequired

UUID of the dataset version to query. Each dataset can have multiple versions representing different states of the data over time

lonnumberRequired

Longitude in decimal degrees (-180 to 180, WGS84/EPSG:4326)

latnumberRequired

Latitude in decimal degrees (-90 to 90, WGS84/EPSG:4326)

Query parameters

api_keystringRequired

Earthscale API key used to authenticate requests and determine which datasets you have access to. API keys can be managed in the Earthscale Web App under the user menu (top-right) -> 'API Settings'

zoomany ofOptional

Map zoom level for fuzzy coordinate matching. When specified, searches within a pixel-sized radius around the coordinates to handle click imprecision. If omitted, returns only exact coordinate matches

integerOptional

or

nullOptional

include_area_in_square_metersbooleanOptional

Calculate and include the geographic area of each feature in square meters using Mollweide equal-area projection. Adds an 'area_m2' property to each feature. Request fails if the dataset already has this column

Default: false

pageintegerOptional

Zero-based page number for paginated results. Each page returns up to 500 items

Default: 0

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/vector/{dataset_version_id}/point/{lon}/{lat}

HTTPcURLJavaScriptPython

GET /v1/vector/{dataset_version_id}/point/{lon}/{lat}?api_key=text HTTP/1.1
Accept: */*

{
  "feature_collection": {
    "bbox": [],
    "type": "text",
    "features": [
      {
        "bbox": [],
        "type": "text",
        "geometry": {
          "bbox": [],
          "type": "text",
          "coordinates": []
        },
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": 1
      }
    ]
  },
  "page_size": 500
}