SpatiaFi API (3.8.2)

Download OpenAPI specification:Download

Metadata

Info

Get geographic metadata for an item.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

item_id

required

string (Item Id)

Item ID

Responses

200

Return a datasets basic info.

422

Validation Error

get/api/info

Request samples

Python
curl

Response samples

application/json

{"bounds": [null,
null,
null,
null
],
"minzoom": 0,
"maxzoom": 0,
"band_metadata": [["string",
{ }
]
],
"band_descriptions": [["string",
"string"
]
],
"dtype": "string",
"nodata_type": "Alpha",
"colorinterp": ["string"
],
"scale": 0,
"offset": 0,
"colormap": {"property1": [0,
0,
0,
0
],
"property2": [0,
0,
0,
0
]
}
}

Info (GeoJSON)

Get geographic metadata for an item and format as a GeoJSON feature.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

item_id

required

string (Item Id)

Item ID

Responses

200

Return a datasets basic info as a GeoJSON feature.

422

Validation Error

get/api/info.geojson

Request samples

Python
curl

Response samples

application/geo+json

{"type": "Feature",
"geometry": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
},
"properties": {"bounds": [null,
null,
null,
null
],
"minzoom": 0,
"maxzoom": 0,
"band_metadata": [["string",
{ }
]
],
"band_descriptions": [["string",
"string"
]
],
"dtype": "string",
"nodata_type": "Alpha",
"colorinterp": ["string"
],
"scale": 0,
"offset": 0,
"colormap": {"property1": [0,
0,
0,
0
],
"property2": [0,
0,
0,
0
]
}
},
"id": 0,
"bbox": [0,
0,
0,
0
]
}

Info 📈

Get geographic metadata for all items in a collection

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime

Responses

200

Metadata

422

Validation Error

get/api/timeseries/info

Request samples

Python
curl

Response samples

application/json

{"property1": {"bounds": [null,
null,
null,
null
],
"minzoom": 0,
"maxzoom": 0,
"band_metadata": [["string",
{ }
]
],
"band_descriptions": [["string",
"string"
]
],
"dtype": "string",
"nodata_type": "Alpha",
"colorinterp": ["string"
],
"scale": 0,
"offset": 0,
"colormap": {"property1": [0,
0,
0,
0
],
"property2": [0,
0,
0,
0
]
}
},
"property2": {"bounds": [null,
null,
null,
null
],
"minzoom": 0,
"maxzoom": 0,
"band_metadata": [["string",
{ }
]
],
"band_descriptions": [["string",
"string"
]
],
"dtype": "string",
"nodata_type": "Alpha",
"colorinterp": ["string"
],
"scale": 0,
"offset": 0,
"colormap": {"property1": [0,
0,
0,
0
],
"property2": [0,
0,
0,
0
]
}
}
}

Info (GeoJSON) 📈

Get geographic metadata for all items in a collection. Return as a GeoJSON feature

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime

Responses

200

Metadata (as a GeoJSON)collection.

422

Validation Error

get/api/timeseries/info.geojson

Request samples

Python
curl

Response samples

application/geo+json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": null,
"properties": {"bounds": [null,
null,
null,
null
],
"minzoom": 0,
"maxzoom": 0,
"band_metadata": [["string",
{ }
]
],
"band_descriptions": [["string",
"string"
]
],
"dtype": "string",
"nodata_type": "Alpha",
"colorinterp": ["string"
],
"scale": 0,
"offset": 0,
"colormap": {"property1": [0,
0,
0,
0
],
"property2": [0,
0,
0,
0
]
}
},
"id": 0,
"bbox": [0,
0,
0,
0
]
}
],
"bbox": [0,
0,
0,
0
]
}

Timesteps 📈

Return a list of available timesteps within a date range.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime

Responses

200

List of available timesteps

422

Validation Error

get/api/timeseries/timesteps

Request samples

Python
curl

Response samples

application/json

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

Spatial Statistics

Statistics

Get geospatial summary statistics of a dataset (mean, min, max, std, percentiles).

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

item_id required	string (Item Id) Item ID
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3

Responses

200

Statistics

422

Validation Error

get/api/statistics

Request samples

Python
curl

Response samples

application/json

{"property1": {"min": 0,
"max": 0,
"mean": 0,
"count": 0,
"sum": 0,
"std": 0,
"median": 0,
"majority": 0,
"minority": 0,
"unique": 0,
"histogram": [[0
]
],
"valid_percent": 0,
"masked_pixels": 0,
"valid_pixels": 0
},
"property2": {"min": 0,
"max": 0,
"mean": 0,
"count": 0,
"sum": 0,
"std": 0,
"median": 0,
"majority": 0,
"minority": 0,
"unique": 0,
"histogram": [[0
]
],
"valid_percent": 0,
"masked_pixels": 0,
"valid_pixels": 0
}
}

Statistics (GeoJSON)

Get geospatial summary statistics for one or more Features in a GeoJSON FeatureCollection.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

item_id required	string (Item Id) Item ID
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3

Request Body schema: application/json
required

Any of:

FeatureCollection Model

type required	string (Type) Value: "FeatureCollection"
required	Array of objects (Features)
	Array of Bbox (any) or Array of Bbox (any) (Bbox)

Responses

200

Summary Statistics.

422

Validation Error

post/api/statistics

Request samples

Payload
Python
curl

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": {"type": "Point",
"coordinates": [0,
0
],
"bbox": [0,
0,
0,
0
]
},
"properties": { },
"id": 0,
"bbox": [0,
0,
0,
0
]
}
],
"bbox": [0,
0,
0,
0
]
}

Response samples

No sample

Statistics 📈

Get geospatial summary statistics of each dataset in a collection.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3

Responses

200

Dataset Geospatial Statistics

422

Validation Error

get/api/timeseries/statistics

Request samples

Python
curl

Response samples

application/json

{"property1": {"property1": {"min": 0,
"max": 0,
"mean": 0,
"count": 0,
"sum": 0,
"std": 0,
"median": 0,
"majority": 0,
"minority": 0,
"unique": 0,
"histogram": [[0
]
],
"valid_percent": 0,
"masked_pixels": 0,
"valid_pixels": 0
},
"property2": {"min": 0,
"max": 0,
"mean": 0,
"count": 0,
"sum": 0,
"std": 0,
"median": 0,
"majority": 0,
"minority": 0,
"unique": 0,
"histogram": [[0
]
],
"valid_percent": 0,
"masked_pixels": 0,
"valid_pixels": 0
}
},
"property2": {"property1": {"min": 0,
"max": 0,
"mean": 0,
"count": 0,
"sum": 0,
"std": 0,
"median": 0,
"majority": 0,
"minority": 0,
"unique": 0,
"histogram": [[0
]
],
"valid_percent": 0,
"masked_pixels": 0,
"valid_pixels": 0
},
"property2": {"min": 0,
"max": 0,
"mean": 0,
"count": 0,
"sum": 0,
"std": 0,
"median": 0,
"majority": 0,
"minority": 0,
"unique": 0,
"histogram": [[0
]
],
"valid_percent": 0,
"masked_pixels": 0,
"valid_pixels": 0
}
}
}

Statistics (GeoJSON) 📈

Get geospatial summary statistics for one or more Features in a GeoJSON FeatureCollection.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3

Request Body schema: application/json
required

Any of:

FeatureCollection Model

type required	string (Type) Value: "FeatureCollection"
required	Array of objects (Features)
	Array of Bbox (any) or Array of Bbox (any) (Bbox)

Responses

200

Summary Statistics

422

Validation Error

post/api/timeseries/statistics

Request samples

Payload
Python
curl

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": {"type": "Point",
"coordinates": [0,
0
],
"bbox": [0,
0,
0,
0
]
},
"properties": { },
"id": 0,
"bbox": [0,
0,
0,
0
]
}
],
"bbox": [0,
0,
0,
0
]
}

Response samples

No sample

Point Value

Get the value at a point for a single item.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

path Parameters

lon required	number (Lon) Longitude
lat required	number (Lat) Latitude

query Parameters

item_id required	string (Item Id) Item ID
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3

Responses

200

Value

422

Validation Error

get/api/point/{lon},{lat}

Request samples

Python
curl

Response samples

application/json

{"coordinates": [0
],
"values": [0
],
"band_names": ["string"
]
}

Point Value (with buffer)

Return the mean value of a dataset in an area around a point

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

path Parameters

lon required	number (Lon) Longitude
lat required	number (Lat) Latitude

query Parameters

r	number (R) Default: 10 Radius of area around point (m)
item_id required	string (Item Id) Item ID
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3

Responses

200

Value

422

Validation Error

get/api/buffer/{lon},{lat}

Request samples

Python
curl

Response samples

application/json

{"coordinates": [0
],
"values": [0
],
"band_names": ["string"
],
"bbox": [0
]
}

Point Value 📈

Return the value at a point location, for all items in the collection.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

path Parameters

lon required	number (Lon) Longitude
lat required	number (Lat) Latitude

query Parameters

coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3

Responses

200

Return the value at a point location, for all datasets in the collection.

422

Validation Error

get/api/timeseries/point/{lon},{lat}

Request samples

Python
curl

Response samples

application/json

{"property1": {"coordinates": [0
],
"values": [0
],
"band_names": ["string"
]
},
"property2": {"coordinates": [0
],
"values": [0
],
"band_names": ["string"
]
}
}

Point Value (with buffer) 📈

Return the mean value of a dataset in an area around a point

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

path Parameters

lon required	number (Lon) Longitude
lat required	number (Lat) Latitude

query Parameters

r	number (R) Default: 10 Radius of area around point (m)
coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3

Responses

200

Value

422

Validation Error

get/api/timeseries/buffer/{lon},{lat}

Request samples

Python
curl

Response samples

application/json

{"coordinates": [0
],
"values": [0
],
"band_names": ["string"
],
"bbox": [0
]
}

Export Image

Preview

Create a downscaled preview image of the entire dataset.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

format	string (ImageType) Output image format. Default is `jpeg` if all pixels are valid, otherwise `png`. Enum: "png" "npy" "tif" "jpeg" "jpg" "jp2" "webp" "pngraw"
item_id required	string (Item Id) Item ID
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3
rescale	Array of strings (Min/Max data Rescaling) comma (',') delimited Min,Max range. Can set multiple time for multiple bands. Example: rescale=0,2000&rescale=0,1000&rescale=0,10000

Responses

200

Return an image.

422

Validation Error

get/api/image/preview

Request samples

Python
curl

Response samples

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Crop (Bounding Box)

Create an image of the dataset, cropped to a bounding box.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

path Parameters

minx required	number (Minx) Bounding box min X
miny required	number (Miny) Bounding box min Y
maxx required	number (Maxx) Bounding box max X
maxy required	number (Maxy) Bounding box max Y

query Parameters

format required	string (ImageType) Output image type. Enum: "png" "npy" "tif" "jpeg" "jpg" "jp2" "webp" "pngraw"
item_id required	string (Item Id) Item ID
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3
rescale	Array of strings (Min/Max data Rescaling) comma (',') delimited Min,Max range. Can set multiple time for multiple bands. Example: rescale=0,2000&rescale=0,1000&rescale=0,10000

Responses

200

Return an image.

422

Validation Error

get/api/image/crop/{minx},{miny},{maxx},{maxy}

Request samples

Python
curl

Response samples

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Crop (GeoJSON)

Create an image of the dataset, cropped to a GeoJSON polygon.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

format	string (ImageType) Output image type. Default is auto. Enum: "png" "npy" "tif" "jpeg" "jpg" "jp2" "webp" "pngraw"
path	string <uri> (Path) [ 1 .. 65536 ] characters Destination path
prefix	string (Prefix) Prefix to add to the filename(s)
item_id required	string (Item Id) Item ID
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3
rescale	Array of strings (Min/Max data Rescaling) comma (',') delimited Min,Max range. Can set multiple time for multiple bands. Example: rescale=0,2000&rescale=0,1000&rescale=0,10000

Request Body schema: application/json
required

type required	string (Type) Value: "Feature"
required	(Geometry (Point (object) or MultiPoint (object) or LineString (object) or MultiLineString (object) or Polygon (object) or MultiPolygon (object))) or GeometryCollection (object) (Geometry)
required	Properties (object) or BaseModel (object) (Properties)
	Id (integer) or Id (string) (Id)
	Array of Bbox (any) or Array of Bbox (any) (Bbox)

Responses

200

Return an image.

422

Validation Error

post/api/image/crop

Request samples

Payload
Python
curl

application/json

{"type": "Feature",
"geometry": {"type": "Point",
"coordinates": [0,
0
],
"bbox": [0,
0,
0,
0
]
},
"properties": { },
"id": 0,
"bbox": [0,
0,
0,
0
]
}

Response samples

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Preview 📈

Create a downscaled preview image of the entire dataset.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

format	string (TimeSeriesImageType) Output image format. Default and only option is `tif`. Value: "tif"
coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3
rescale	Array of strings (Min/Max data Rescaling) comma (',') delimited Min,Max range. Can set multiple time for multiple bands. Example: rescale=0,2000&rescale=0,1000&rescale=0,10000

Responses

200

Return an image.

422

Validation Error

get/api/timeseries/image/preview

Request samples

Python
curl

Response samples

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Crop (Bounding Box) 📈

Create an image of the dataset, cropped to a bounding box.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

path Parameters

minx required	number (Minx) Bounding box min X
miny required	number (Miny) Bounding box min Y
maxx required	number (Maxx) Bounding box max X
maxy required	number (Maxy) Bounding box max Y

query Parameters

format	string (TimeSeriesImageType) Output image type. Default and only option is `tif` Value: "tif"
coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3
rescale	Array of strings (Min/Max data Rescaling) comma (',') delimited Min,Max range. Can set multiple time for multiple bands. Example: rescale=0,2000&rescale=0,1000&rescale=0,10000

Responses

200

Return an image.

422

Validation Error

get/api/timeseries/image/crop/{minx},{miny},{maxx},{maxy}

Request samples

Python
curl

Response samples

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Crop (GeoJSON) 📈

Create an image of the dataset, cropped to a GeoJSON polygon.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

format	string (TimeSeriesImageType) Output image type. Default is tif. Value: "tif"
path	string <uri> (Path) [ 1 .. 65536 ] characters Destination path
prefix	string (Prefix) Prefix to add to the filename(s)
coll_id required	string (Coll Id) Collection ID
datetime	string (Datetime) Datetime
bidx	Array of integers (Band indexes) Dataset band indexes Examples: one-band bidx=1 multi-bands bidx=1&bidx=2&bidx=3
rescale	Array of strings (Min/Max data Rescaling) comma (',') delimited Min,Max range. Can set multiple time for multiple bands. Example: rescale=0,2000&rescale=0,1000&rescale=0,10000

Request Body schema: application/json
required

type required	string (Type) Value: "Feature"
required	(Geometry (Point (object) or MultiPoint (object) or LineString (object) or MultiLineString (object) or Polygon (object) or MultiPolygon (object))) or GeometryCollection (object) (Geometry)
required	Properties (object) or BaseModel (object) (Properties)
	Id (integer) or Id (string) (Id)
	Array of Bbox (any) or Array of Bbox (any) (Bbox)

Responses

200

Return an image.

422

Validation Error

post/api/timeseries/image/crop

Request samples

Payload
Python
curl

application/json

{"type": "Feature",
"geometry": {"type": "Point",
"coordinates": [0,
0
],
"bbox": [0,
0,
0,
0
]
},
"properties": { },
"id": 0,
"bbox": [0,
0,
0,
0
]
}

Response samples

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Search

Basic Search

This is a simple search endpoint that returns a GeoJSON FeatureCollection of STAC Items.

Results are filtered to only include items which are available to the user.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

collections	string (Collections) Limit search to specific collections
ids	string (Ids) Limit search to specific item ids
bbox	string (Bbox) Limit search to items intersecting a bounding box
	Datetime (string) or Datetime (string) (Datetime) Limit search to items intersecting a datetime
limit	integer (Limit) [ 0 .. 10000 ] Default: 100 Limit the number of items returned

Responses

200

Successful Response

422

Validation Error

get/search

Request samples

Python
curl

Response samples

application/geo+json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": {"type": "Point",
"coordinates": [0,
0
],
"bbox": [0,
0,
0,
0
]
},
"properties": { },
"id": 0,
"bbox": [0,
0,
0,
0
]
}
],
"bbox": [0,
0,
0,
0
]
}

Advanced Search

This search endpoint allows for more advanced search parameters.

Results are filtered to only include items which are available to the user.

SecurityOAuth2ClientBearer or OAuth2PasswordBearer

Request

query Parameters

limit

integer (Limit) [ 0 .. 10000 ]

Default: 100

Request Body schema: application/json
required

collections	Array of strings (Collections)
ids	Array of strings (Ids)
	Array of Bbox (any) or Array of Bbox (any) (Bbox)
	Point (object) or MultiPoint (object) or LineString (object) or MultiLineString (object) or Polygon (object) or MultiPolygon (object) or GeometryCollection (object) (Intersects)
datetime	string (Datetime)
limit	integer (Limit) Default: 10

Responses

200

Successful Response

422

Validation Error

post/search

Request samples

Payload
Python
curl

application/json

{"collections": ["string"
],
"ids": ["string"
],
"bbox": [0,
0,
0,
0
],
"intersects": {"type": "Point",
"coordinates": [0,
0
],
"bbox": [0,
0,
0,
0
]
},
"datetime": "string",
"limit": 10
}

Response samples

application/geo+json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": {"type": "Point",
"coordinates": [0,
0
],
"bbox": [0,
0,
0,
0
]
},
"properties": { },
"id": 0,
"bbox": [0,
0,
0,
0
]
}
],
"bbox": [0,
0,
0,
0
]
}

SpatiaFi API (3.8.2)

Metadata

Info

query Parameters

Info (GeoJSON)

query Parameters

Info 📈

query Parameters

Info (GeoJSON) 📈

query Parameters

Timesteps 📈

query Parameters

Spatial Statistics

Statistics

query Parameters

Statistics (GeoJSON)

query Parameters

Request Body schema: application/jsonrequired

Statistics 📈

query Parameters

Statistics (GeoJSON) 📈

query Parameters

Request Body schema: application/jsonrequired

Point Value

Point Value

path Parameters

query Parameters

Point Value (with buffer)

path Parameters

query Parameters

Point Value 📈

path Parameters

query Parameters

Point Value (with buffer) 📈

path Parameters

query Parameters

Export Image

Preview

query Parameters

Crop (Bounding Box)

path Parameters

query Parameters

Crop (GeoJSON)

query Parameters

Request Body schema: application/jsonrequired

Preview 📈

query Parameters

Crop (Bounding Box) 📈

path Parameters

query Parameters

Crop (GeoJSON) 📈

query Parameters

Request Body schema: application/jsonrequired

Search

Basic Search

query Parameters

Advanced Search

query Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required