{
"openapi": "3.1.0",
"info": {
"title": "titiler-pgstac",
"description": "Dynamic Raster Tiler with PgSTAC backend.\n\n---\n\n**Documentation**: https://stac-utils.github.io/titiler-pgstac/\n\n**Source Code**: https://github.com/stac-utils/titiler-pgstac\n\n---\n ",
"version": "3.0.0"
},
"paths": {
"/searches/{search_id}/tiles": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Retrieve a list of available raster tilesets for the specified dataset.",
"description": "Retrieve a list of available raster tilesets for the specified dataset.",
"operationId": ".searches.{search_id}.getTileSetList",
"parameters": [
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
},
{
"name": "crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System.",
"title": "Crs"
},
"description": "Coordinate Reference System."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileSetList"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/tiles/{tileMatrixSetId}": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).",
"description": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).",
"operationId": ".searches.{search_id}.getTileSet",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileSet"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Tile",
"description": "Create map tile from a COG.",
"operationId": ".searches.{search_id}.getTileWithFormat",
"parameters": [
{
"name": "z",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.",
"title": "Z"
},
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile."
},
{
"name": "x",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.",
"title": "X"
},
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix."
},
{
"name": "y",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.",
"title": "Y"
},
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix."
},
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels.",
"title": "Tilesize"
},
"description": "Tilesize in pixels."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Tile",
"description": "Create map tile from a COG.",
"operationId": ".searches.{search_id}.getTile",
"parameters": [
{
"name": "z",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.",
"title": "Z"
},
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile."
},
{
"name": "x",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.",
"title": "X"
},
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix."
},
{
"name": "y",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.",
"title": "Y"
},
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix."
},
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels.",
"title": "Tilesize"
},
"description": "Tilesize in pixels."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/{tileMatrixSetId}/map.html": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Map Viewer",
"description": "Return TileJSON document for a dataset.",
"operationId": ".searches.{search_id}.getMapViewer",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Tile Format"
},
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"exclusiveMinimum": 0,
"description": "Tilesize in pixels. Default to 256.",
"default": 256,
"title": "Tilesize"
},
"description": "Tilesize in pixels. Default to 256."
},
{
"name": "minzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default minzoom.",
"title": "Minzoom"
},
"description": "Overwrite default minzoom."
},
{
"name": "maxzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default maxzoom.",
"title": "Maxzoom"
},
"description": "Overwrite default maxzoom."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/{tileMatrixSetId}/tilejson.json": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Tilejson",
"description": "Return TileJSON document for a COG.",
"operationId": ".searches.{search_id}.getTileJSON",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels. Default to 512.",
"title": "Tilesize"
},
"description": "Tilesize in pixels. Default to 512."
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Tile Format"
},
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
},
{
"name": "minzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default minzoom.",
"title": "Minzoom"
},
"description": "Overwrite default minzoom."
},
{
"name": "maxzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default maxzoom.",
"title": "Maxzoom"
},
"description": "Overwrite default maxzoom."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return a tilejson",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileJSON"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/point/{lon},{lat}": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Point",
"description": "Get Point value for a Mosaic.",
"operationId": ".searches.{search_id}.getDataForPoint",
"parameters": [
{
"name": "lon",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Longitude",
"title": "Lon"
},
"description": "Longitude"
},
{
"name": "lat",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Latitude",
"title": "Lat"
},
"description": "Latitude"
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
}
],
"responses": {
"200": {
"description": "Return a value for a point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/titiler__mosaic__models__responses__Point"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/bbox/{minx},{miny},{maxx},{maxy}/assets": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Assets For Bbox",
"description": "Return a list of assets which overlap a bounding box",
"operationId": ".searches.{search_id}.getAssetsForBoundingBox",
"parameters": [
{
"name": "minx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min X",
"title": "Minx"
},
"description": "Bounding box min X"
},
{
"name": "miny",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min Y",
"title": "Miny"
},
"description": "Bounding box min Y"
},
{
"name": "maxx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max X",
"title": "Maxx"
},
"description": "Bounding box max X"
},
{
"name": "maxy",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max Y",
"title": "Maxy"
},
"description": "Bounding box max Y"
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
}
],
"responses": {
"200": {
"description": "Return list of COGs in bounding box",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/point/{lon},{lat}/assets": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Assets For Lon Lat",
"description": "Return a list of assets which overlap a point",
"operationId": ".searches.{search_id}.getAssetsForPoint",
"parameters": [
{
"name": "lon",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Longitude",
"title": "Lon"
},
"description": "Longitude"
},
{
"name": "lat",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Latitude",
"title": "Lat"
},
"description": "Latitude"
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
}
],
"responses": {
"200": {
"description": "Return list of COGs",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}/assets": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Assets For Tile",
"description": "Return a list of assets which overlap a given tile",
"operationId": ".searches.{search_id}.getAssetsForTile",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "z",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.",
"title": "Z"
},
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile."
},
{
"name": "x",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.",
"title": "X"
},
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix."
},
{
"name": "y",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.",
"title": "Y"
},
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix."
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
}
],
"responses": {
"200": {
"description": "Return list of COGs",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/bbox/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Bbox Image",
"description": "Create image from a bbox.",
"operationId": ".searches.{search_id}.getDataForBoundingBoxWithSizesAndFormat",
"parameters": [
{
"name": "minx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min X",
"title": "Minx"
},
"description": "Bounding box min X"
},
{
"name": "miny",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min Y",
"title": "Miny"
},
"description": "Bounding box min Y"
},
{
"name": "maxx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max X",
"title": "Maxx"
},
"description": "Bounding box max X"
},
{
"name": "maxy",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max Y",
"title": "Maxy"
},
"description": "Bounding box max Y"
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/ImageType",
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
}
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "height",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/bbox/{minx},{miny},{maxx},{maxy}.{format}": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Bbox Image",
"description": "Create image from a bbox.",
"operationId": ".searches.{search_id}.getDataForBoundingBoxWithFormat",
"parameters": [
{
"name": "minx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min X",
"title": "Minx"
},
"description": "Bounding box min X"
},
{
"name": "miny",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min Y",
"title": "Miny"
},
"description": "Bounding box min Y"
},
{
"name": "maxx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max X",
"title": "Maxx"
},
"description": "Bounding box max X"
},
{
"name": "maxy",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max Y",
"title": "Maxy"
},
"description": "Bounding box max Y"
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/ImageType",
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
}
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/feature/{width}x{height}.{format}": {
"post": {
"tags": [
"STAC Search"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".searches.{search_id}.postDataForGeoJSONWithSizesAndFormat",
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "height",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/feature.{format}": {
"post": {
"tags": [
"STAC Search"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".searches.{search_id}.postDataForGeoJSONWithFormat",
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/feature": {
"post": {
"tags": [
"STAC Search"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".searches.{search_id}.postDataForGeoJSON",
"parameters": [
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/statistics": {
"post": {
"tags": [
"STAC Search"
],
"summary": "Geojson Statistics",
"description": "Get Statistics from a geojson feature or featureCollection.",
"operationId": ".searches.{search_id}.postStatisticsForGeoJSON",
"parameters": [
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "categorical",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return statistics for categorical dataset. Defaults to `False`",
"title": "Categorical"
},
"description": "Return statistics for categorical dataset. Defaults to `False`"
},
{
"name": "c",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
},
{
"type": "null"
}
],
"title": "Pixels values for categories.",
"description": "List of values for which to report counts.",
"examples": [
1,
2,
3
]
},
"description": "List of values for which to report counts."
},
{
"name": "p",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "null"
}
],
"title": "Percentile values",
"description": "List of percentile values (default to [2, 98]).",
"examples": [
2,
5,
95,
98
]
},
"description": "List of percentile values (default to [2, 98])."
},
{
"name": "histogram_bins",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+(,\\d+)*$"
},
{
"type": "null"
}
],
"title": "Histogram bins.",
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"simple": {
"description": "Defines the number of equal-width bins",
"value": 8
},
"array": {
"description": "Defines custom bin edges (comma `,` delimited values)",
"value": "0,100,200,300"
}
}
},
{
"name": "histogram_range",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$"
},
{
"type": "null"
}
],
"title": "Histogram range",
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"array": {
"description": "Defines custom histogram range (comma `,` delimited values)",
"value": "0,1000"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/FeatureCollection"
},
{
"$ref": "#/components/schemas/Feature"
}
],
"description": "GeoJSON Feature or FeatureCollection.",
"title": "Geojson"
}
}
}
},
"responses": {
"200": {
"description": "Return statistics for geojson features.",
"content": {
"application/geo+json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/FeatureCollection_Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type_____StatisticsInGeoJSON__"
},
{
"$ref": "#/components/schemas/Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_"
}
],
"title": "Response .Searches.{Search Id}.Poststatisticsforgeojson"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/info": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Info",
"description": "Get Search query metadata.",
"operationId": ".searches.{search_id}.getInfo",
"parameters": [
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
}
],
"responses": {
"200": {
"description": "Get Search query metadata.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/titiler__pgstac__model__Info"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/{search_id}/WMTSCapabilities.xml": {
"get": {
"tags": [
"STAC Search"
],
"summary": "Wmts",
"description": "OGC RESTful WMTS endpoint.",
"operationId": ".searches.{search_id}.getWMTS",
"parameters": [
{
"name": "search_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "PgSTAC Search Identifier (Hash)",
"title": "Search Id"
},
"description": "PgSTAC Search Identifier (Hash)"
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ImageType",
"description": "Output image type. Default is png.",
"default": "png"
},
"description": "Output image type. Default is png."
},
{
"name": "use_epsg",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)",
"default": false,
"title": "Use Epsg"
},
"description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
}
],
"responses": {
"200": {
"description": "Return RESTful WMTS service capabilities document.",
"content": {
"application/xml": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/list": {
"get": {
"tags": [
"STAC Search"
],
"summary": "List Searches",
"description": "List a PgSTAC Searches.",
"operationId": ".searches.getMosaicList-deprecated",
"deprecated": true,
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Page size limit",
"default": 10,
"title": "Limit"
},
"description": "Page size limit"
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "Page offset",
"default": 0,
"title": "Offset"
},
"description": "Page offset"
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Sort the response items by a property (ascending (default) or descending).",
"title": "Sortby"
},
"description": "Sort the response items by a property (ascending (default) or descending)."
}
],
"responses": {
"200": {
"description": "List Mosaics in PgSTAC.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Infos"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/": {
"get": {
"tags": [
"STAC Search"
],
"summary": "List Searches",
"description": "List a PgSTAC Searches.",
"operationId": ".searches.getMosaicList",
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Page size limit",
"default": 10,
"title": "Limit"
},
"description": "Page size limit"
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "Page offset",
"default": 0,
"title": "Offset"
},
"description": "Page offset"
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Sort the response items by a property (ascending (default) or descending).",
"title": "Sortby"
},
"description": "Sort the response items by a property (ascending (default) or descending)."
}
],
"responses": {
"200": {
"description": "List Mosaics in PgSTAC.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Infos"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/searches/register": {
"post": {
"tags": [
"STAC Search"
],
"summary": "Register Search",
"description": "Register a Search query.",
"operationId": ".searches.Register",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterMosaic"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Register a Virtual Mosaic (PgSTAC Search).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/tiles": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Retrieve a list of available raster tilesets for the specified dataset.",
"description": "Retrieve a list of available raster tilesets for the specified dataset.",
"operationId": ".collections.{collection_id}.getTileSetList",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System.",
"title": "Crs"
},
"description": "Coordinate Reference System."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileSetList"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/tiles/{tileMatrixSetId}": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).",
"description": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).",
"operationId": ".collections.{collection_id}.getTileSet",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileSet"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Tile",
"description": "Create map tile from a COG.",
"operationId": ".collections.{collection_id}.getTileWithFormat",
"parameters": [
{
"name": "z",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.",
"title": "Z"
},
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile."
},
{
"name": "x",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.",
"title": "X"
},
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix."
},
{
"name": "y",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.",
"title": "Y"
},
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix."
},
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels.",
"title": "Tilesize"
},
"description": "Tilesize in pixels."
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Tile",
"description": "Create map tile from a COG.",
"operationId": ".collections.{collection_id}.getTile",
"parameters": [
{
"name": "z",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.",
"title": "Z"
},
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile."
},
{
"name": "x",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.",
"title": "X"
},
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix."
},
{
"name": "y",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.",
"title": "Y"
},
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix."
},
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels.",
"title": "Tilesize"
},
"description": "Tilesize in pixels."
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/{tileMatrixSetId}/map.html": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Map Viewer",
"description": "Return TileJSON document for a dataset.",
"operationId": ".collections.{collection_id}.getMapViewer",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Tile Format"
},
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"exclusiveMinimum": 0,
"description": "Tilesize in pixels. Default to 256.",
"default": 256,
"title": "Tilesize"
},
"description": "Tilesize in pixels. Default to 256."
},
{
"name": "minzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default minzoom.",
"title": "Minzoom"
},
"description": "Overwrite default minzoom."
},
{
"name": "maxzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default maxzoom.",
"title": "Maxzoom"
},
"description": "Overwrite default maxzoom."
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/{tileMatrixSetId}/tilejson.json": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Tilejson",
"description": "Return TileJSON document for a COG.",
"operationId": ".collections.{collection_id}.getTileJSON",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels. Default to 512.",
"title": "Tilesize"
},
"description": "Tilesize in pixels. Default to 512."
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Tile Format"
},
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
},
{
"name": "minzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default minzoom.",
"title": "Minzoom"
},
"description": "Overwrite default minzoom."
},
{
"name": "maxzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default maxzoom.",
"title": "Maxzoom"
},
"description": "Overwrite default maxzoom."
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return a tilejson",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileJSON"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/point/{lon},{lat}": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Point",
"description": "Get Point value for a Mosaic.",
"operationId": ".collections.{collection_id}.getDataForPoint",
"parameters": [
{
"name": "lon",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Longitude",
"title": "Lon"
},
"description": "Longitude"
},
{
"name": "lat",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Latitude",
"title": "Lat"
},
"description": "Latitude"
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
}
],
"responses": {
"200": {
"description": "Return a value for a point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/titiler__mosaic__models__responses__Point"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/bbox/{minx},{miny},{maxx},{maxy}/assets": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Assets For Bbox",
"description": "Return a list of assets which overlap a bounding box",
"operationId": ".collections.{collection_id}.getAssetsForBoundingBox",
"parameters": [
{
"name": "minx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min X",
"title": "Minx"
},
"description": "Bounding box min X"
},
{
"name": "miny",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min Y",
"title": "Miny"
},
"description": "Bounding box min Y"
},
{
"name": "maxx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max X",
"title": "Maxx"
},
"description": "Bounding box max X"
},
{
"name": "maxy",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max Y",
"title": "Maxy"
},
"description": "Bounding box max Y"
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
}
],
"responses": {
"200": {
"description": "Return list of COGs in bounding box",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/point/{lon},{lat}/assets": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Assets For Lon Lat",
"description": "Return a list of assets which overlap a point",
"operationId": ".collections.{collection_id}.getAssetsForPoint",
"parameters": [
{
"name": "lon",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Longitude",
"title": "Lon"
},
"description": "Longitude"
},
{
"name": "lat",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Latitude",
"title": "Lat"
},
"description": "Latitude"
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
}
],
"responses": {
"200": {
"description": "Return list of COGs",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}/assets": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Assets For Tile",
"description": "Return a list of assets which overlap a given tile",
"operationId": ".collections.{collection_id}.getAssetsForTile",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "z",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.",
"title": "Z"
},
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile."
},
{
"name": "x",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.",
"title": "X"
},
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix."
},
{
"name": "y",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.",
"title": "Y"
},
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
}
],
"responses": {
"200": {
"description": "Return list of COGs",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/bbox/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Bbox Image",
"description": "Create image from a bbox.",
"operationId": ".collections.{collection_id}.getDataForBoundingBoxWithSizesAndFormat",
"parameters": [
{
"name": "minx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min X",
"title": "Minx"
},
"description": "Bounding box min X"
},
{
"name": "miny",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min Y",
"title": "Miny"
},
"description": "Bounding box min Y"
},
{
"name": "maxx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max X",
"title": "Maxx"
},
"description": "Bounding box max X"
},
{
"name": "maxy",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max Y",
"title": "Maxy"
},
"description": "Bounding box max Y"
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/ImageType",
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "height",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/bbox/{minx},{miny},{maxx},{maxy}.{format}": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Bbox Image",
"description": "Create image from a bbox.",
"operationId": ".collections.{collection_id}.getDataForBoundingBoxWithFormat",
"parameters": [
{
"name": "minx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min X",
"title": "Minx"
},
"description": "Bounding box min X"
},
{
"name": "miny",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min Y",
"title": "Miny"
},
"description": "Bounding box min Y"
},
{
"name": "maxx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max X",
"title": "Maxx"
},
"description": "Bounding box max X"
},
{
"name": "maxy",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max Y",
"title": "Maxy"
},
"description": "Bounding box max Y"
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/ImageType",
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/feature/{width}x{height}.{format}": {
"post": {
"tags": [
"STAC Collection"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".collections.{collection_id}.postDataForGeoJSONWithSizesAndFormat",
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "height",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/feature.{format}": {
"post": {
"tags": [
"STAC Collection"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".collections.{collection_id}.postDataForGeoJSONWithFormat",
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/feature": {
"post": {
"tags": [
"STAC Collection"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".collections.{collection_id}.postDataForGeoJSON",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/statistics": {
"post": {
"tags": [
"STAC Collection"
],
"summary": "Geojson Statistics",
"description": "Get Statistics from a geojson feature or featureCollection.",
"operationId": ".collections.{collection_id}.postStatisticsForGeoJSON",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "categorical",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return statistics for categorical dataset. Defaults to `False`",
"title": "Categorical"
},
"description": "Return statistics for categorical dataset. Defaults to `False`"
},
{
"name": "c",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
},
{
"type": "null"
}
],
"title": "Pixels values for categories.",
"description": "List of values for which to report counts.",
"examples": [
1,
2,
3
]
},
"description": "List of values for which to report counts."
},
{
"name": "p",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "null"
}
],
"title": "Percentile values",
"description": "List of percentile values (default to [2, 98]).",
"examples": [
2,
5,
95,
98
]
},
"description": "List of percentile values (default to [2, 98])."
},
{
"name": "histogram_bins",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+(,\\d+)*$"
},
{
"type": "null"
}
],
"title": "Histogram bins.",
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"simple": {
"description": "Defines the number of equal-width bins",
"value": 8
},
"array": {
"description": "Defines custom bin edges (comma `,` delimited values)",
"value": "0,100,200,300"
}
}
},
{
"name": "histogram_range",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$"
},
{
"type": "null"
}
],
"title": "Histogram range",
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"array": {
"description": "Defines custom histogram range (comma `,` delimited values)",
"value": "0,1000"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/FeatureCollection"
},
{
"$ref": "#/components/schemas/Feature"
}
],
"description": "GeoJSON Feature or FeatureCollection.",
"title": "Geojson"
}
}
}
},
"responses": {
"200": {
"description": "Return statistics for geojson features.",
"content": {
"application/geo+json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/FeatureCollection_Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type_____StatisticsInGeoJSON__"
},
{
"$ref": "#/components/schemas/Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_"
}
],
"title": "Response .Collections.{Collection Id}.Poststatisticsforgeojson"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/info": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Info",
"description": "Get Search query metadata.",
"operationId": ".collections.{collection_id}.getInfo",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
}
],
"responses": {
"200": {
"description": "Get Search query metadata.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/titiler__pgstac__model__Info"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/WMTSCapabilities.xml": {
"get": {
"tags": [
"STAC Collection"
],
"summary": "Wmts",
"description": "OGC RESTful WMTS endpoint.",
"operationId": ".collections.{collection_id}.getWMTS",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ImageType",
"description": "Output image type. Default is png.",
"default": "png"
},
"description": "Output image type. Default is png."
},
{
"name": "use_epsg",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)",
"default": false,
"title": "Use Epsg"
},
"description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)"
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Array of Item ids",
"title": "Ids"
},
"description": "Array of Item ids",
"examples": {
"user-provided": {},
"multiple-items": {
"value": "item1,item2"
}
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items intersecting this bounding box",
"title": "Bbox"
},
"description": "Filters items intersecting this bounding box",
"examples": {
"user-provided": {},
"Montreal": {
"value": "-73.896103,45.364690,-73.413734,45.674283"
}
}
},
{
"name": "datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"title": "Datetime"
},
"description": "Filters items that have a temporal property that intersects this value.\n\nEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.",
"examples": {
"user-defined": {},
"datetime": {
"value": "2018-02-12T23:20:50Z"
},
"closed-interval": {
"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
},
"open-interval-from": {
"value": "2018-02-12T00:00:00Z/.."
},
"open-interval-to": {
"value": "../2018-03-18T12:31:12Z"
}
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Allows additional filtering based on the properties of Item objects",
"title": "Query"
},
"description": "Allows additional filtering based on the properties of Item objects",
"examples": {
"user-provided": {},
"cloudy": {
"value": "{\"eo:cloud_cover\": {\"gte\": 95}}"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"title": "Sortby"
},
"description": "An array of property names, prefixed by either '+' for ascending or '-' for descending. If no prefix is provided, '+' is assumed.",
"examples": {
"user-provided": {},
"resolution": {
"value": "-gsd"
},
"resolution-and-dates": {
"value": "-gsd,-datetime"
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"title": "Filter"
},
"description": "A CQL2 filter expression for filtering items.\n\nSupports `CQL2-JSON` as defined in https://docs.ogc.org/is/21-065r2/21-065r2.htmln\nRemember to URL encode the CQL2-JSON if using GET",
"examples": {
"user-provided": {},
"landsat8-item": {
"value": "id='LC08_L1TP_060247_20180905_20180912_01_T1_L1TP' AND collection='landsat8_l1tp'"
}
}
},
{
"name": "filter-lang",
"in": "query",
"required": false,
"schema": {
"enum": [
"cql2-text",
"cql2-json"
],
"type": "string",
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text.",
"default": "cql2-text",
"title": "Filter-Lang"
},
"description": "CQL2 Language (cql2-text, cql2-json). Defaults to cql2-text."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "pixel_selection",
"in": "query",
"required": false,
"schema": {
"enum": [
"first",
"highest",
"lowest",
"mean",
"median",
"stdev",
"lastbandlow",
"lastbandhigh",
"count"
],
"type": "string",
"description": "Pixel selection method.",
"default": "first",
"title": "Pixel Selection"
},
"description": "Pixel selection method."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "scan_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC).",
"title": "Scan Limit"
},
"description": "Return as soon as we scan N items (defaults to 10000 in PgSTAC)."
},
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC).",
"title": "Items Limit"
},
"description": "Return as soon as we have N items per geometry (defaults to 100 in PgSTAC)."
},
{
"name": "time_limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC).",
"title": "Time Limit"
},
"description": "Return after N seconds to avoid long requests (defaults to 5 in PgSTAC)."
},
{
"name": "exitwhenfull",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC).",
"title": "Exitwhenfull"
},
"description": "Return as soon as the geometry is fully covered (defaults to True in PgSTAC)."
},
{
"name": "skipcovered",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC).",
"title": "Skipcovered"
},
"description": "Skip any items that would show up completely under the previous items (defaults to True in PgSTAC)."
}
],
"responses": {
"200": {
"description": "Return RESTful WMTS service capabilities document.",
"content": {
"application/xml": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/info": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Info",
"description": "Return dataset's basic info or the list of available assets.",
"operationId": ".collections.{collection_id}.items.{item_id}.getInfo",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
}
],
"responses": {
"200": {
"description": "Return dataset's basic info or the list of available assets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/rio_tiler__models__Info"
},
"title": "Response .Collections.{Collection Id}.Items.{Item Id}.Getinfo"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/info.geojson": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Info Geojson",
"description": "Return dataset's basic info as a GeoJSON feature.",
"operationId": ".collections.{collection_id}.items.{item_id}.getInfoGeoJSON",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System.",
"title": "Crs"
},
"description": "Coordinate Reference System."
}
],
"responses": {
"200": {
"description": "Return dataset's basic info as a GeoJSON feature.",
"content": {
"application/geo+json": {
"schema": {
"$ref": "#/components/schemas/Feature_Union_Polygon__MultiPolygon__dict_str__Info__"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/assets": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Available Assets",
"description": "Return a list of supported assets.",
"operationId": ".collections.{collection_id}.items.{item_id}.getAssets",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
}
],
"responses": {
"200": {
"description": "Return a list of supported assets.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Response .Collections.{Collection Id}.Items.{Item Id}.Getassets"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/asset_statistics": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Asset Statistics",
"description": "Per Asset statistics",
"operationId": ".collections.{collection_id}.items.{item_id}.getAssetsStatistics",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"description": "Maximum image size to read onto.",
"default": 1024,
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "categorical",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return statistics for categorical dataset. Defaults to `False`",
"title": "Categorical"
},
"description": "Return statistics for categorical dataset. Defaults to `False`"
},
{
"name": "c",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
},
{
"type": "null"
}
],
"title": "Pixels values for categories.",
"description": "List of values for which to report counts.",
"examples": [
1,
2,
3
]
},
"description": "List of values for which to report counts."
},
{
"name": "p",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "null"
}
],
"title": "Percentile values",
"description": "List of percentile values (default to [2, 98]).",
"examples": [
2,
5,
95,
98
]
},
"description": "List of percentile values (default to [2, 98])."
},
{
"name": "histogram_bins",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+(,\\d+)*$"
},
{
"type": "null"
}
],
"title": "Histogram bins.",
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"simple": {
"description": "Defines the number of equal-width bins",
"value": 8
},
"array": {
"description": "Defines custom bin edges (comma `,` delimited values)",
"value": "0,100,200,300"
}
}
},
{
"name": "histogram_range",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$"
},
{
"type": "null"
}
],
"title": "Histogram range",
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"array": {
"description": "Defines custom histogram range (comma `,` delimited values)",
"value": "0,1000"
}
}
}
],
"responses": {
"200": {
"description": "Return dataset's statistics.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BandStatistics"
}
},
"title": "Response .Collections.{Collection Id}.Items.{Item Id}.Getassetsstatistics"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/statistics": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Statistics",
"description": "Merged assets statistics.",
"operationId": ".collections.{collection_id}.items.{item_id}.getStatistics",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"description": "Maximum image size to read onto.",
"default": 1024,
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "categorical",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return statistics for categorical dataset. Defaults to `False`",
"title": "Categorical"
},
"description": "Return statistics for categorical dataset. Defaults to `False`"
},
{
"name": "c",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
},
{
"type": "null"
}
],
"title": "Pixels values for categories.",
"description": "List of values for which to report counts.",
"examples": [
1,
2,
3
]
},
"description": "List of values for which to report counts."
},
{
"name": "p",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "null"
}
],
"title": "Percentile values",
"description": "List of percentile values (default to [2, 98]).",
"examples": [
2,
5,
95,
98
]
},
"description": "List of percentile values (default to [2, 98])."
},
{
"name": "histogram_bins",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+(,\\d+)*$"
},
{
"type": "null"
}
],
"title": "Histogram bins.",
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"simple": {
"description": "Defines the number of equal-width bins",
"value": 8
},
"array": {
"description": "Defines custom bin edges (comma `,` delimited values)",
"value": "0,100,200,300"
}
}
},
{
"name": "histogram_range",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$"
},
{
"type": "null"
}
],
"title": "Histogram range",
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"array": {
"description": "Defines custom histogram range (comma `,` delimited values)",
"value": "0,1000"
}
}
}
],
"responses": {
"200": {
"description": "Return dataset's statistics.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BandStatistics"
},
"title": "Response .Collections.{Collection Id}.Items.{Item Id}.Getstatistics"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"STAC Item"
],
"summary": "Geojson Statistics",
"description": "Get Statistics from a geojson feature or featureCollection.",
"operationId": ".collections.{collection_id}.items.{item_id}.postStatisticsForGeoJSON",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "categorical",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Return statistics for categorical dataset. Defaults to `False`",
"title": "Categorical"
},
"description": "Return statistics for categorical dataset. Defaults to `False`"
},
{
"name": "c",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
},
{
"type": "null"
}
],
"title": "Pixels values for categories.",
"description": "List of values for which to report counts.",
"examples": [
1,
2,
3
]
},
"description": "List of values for which to report counts."
},
{
"name": "p",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "null"
}
],
"title": "Percentile values",
"description": "List of percentile values (default to [2, 98]).",
"examples": [
2,
5,
95,
98
]
},
"description": "List of percentile values (default to [2, 98])."
},
{
"name": "histogram_bins",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+(,\\d+)*$"
},
{
"type": "null"
}
],
"title": "Histogram bins.",
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"simple": {
"description": "Defines the number of equal-width bins",
"value": 8
},
"array": {
"description": "Defines custom bin edges (comma `,` delimited values)",
"value": "0,100,200,300"
}
}
},
{
"name": "histogram_range",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$"
},
{
"type": "null"
}
],
"title": "Histogram range",
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n "
},
"description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ",
"examples": {
"user-provided": {},
"array": {
"description": "Defines custom histogram range (comma `,` delimited values)",
"value": "0,1000"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/FeatureCollection"
},
{
"$ref": "#/components/schemas/Feature"
}
],
"description": "GeoJSON Feature or FeatureCollection.",
"title": "Geojson"
}
}
}
},
"responses": {
"200": {
"description": "Return dataset's statistics from feature or featureCollection.",
"content": {
"application/geo+json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/FeatureCollection_Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type_____StatisticsInGeoJSON__"
},
{
"$ref": "#/components/schemas/Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_"
}
],
"title": "Response .Collections.{Collection Id}.Items.{Item Id}.Poststatisticsforgeojson"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/tiles": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Retrieve a list of available raster tilesets for the specified dataset.",
"description": "Retrieve a list of available raster tilesets for the specified dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getTileSetList",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
},
{
"name": "crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System.",
"title": "Crs"
},
"description": "Coordinate Reference System."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileSetList"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/tiles/{tileMatrixSetId}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).",
"description": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).",
"operationId": ".collections.{collection_id}.items.{item_id}.getTileSet",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileSet"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Tile",
"description": "Create map tile from a dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getTileWithFormat",
"parameters": [
{
"name": "z",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.",
"title": "Z"
},
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile."
},
{
"name": "x",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.",
"title": "X"
},
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix."
},
{
"name": "y",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.",
"title": "Y"
},
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix."
},
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels.",
"title": "Tilesize"
},
"description": "Tilesize in pixels."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Tile",
"description": "Create map tile from a dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getTile",
"parameters": [
{
"name": "z",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.",
"title": "Z"
},
"description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile."
},
{
"name": "x",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.",
"title": "X"
},
"description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix."
},
{
"name": "y",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.",
"title": "Y"
},
"description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix."
},
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels.",
"title": "Tilesize"
},
"description": "Tilesize in pixels."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/{tileMatrixSetId}/map.html": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Map Viewer",
"description": "Return TileJSON document for a dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getMapViewer",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Tile Format"
},
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"exclusiveMinimum": 0,
"description": "Tilesize in pixels. Default to 256.",
"default": 256,
"title": "Tilesize"
},
"description": "Tilesize in pixels. Default to 256."
},
{
"name": "minzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default minzoom.",
"title": "Minzoom"
},
"description": "Overwrite default minzoom."
},
{
"name": "maxzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default maxzoom.",
"title": "Maxzoom"
},
"description": "Overwrite default maxzoom."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/{tileMatrixSetId}/tilejson.json": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Tilejson",
"description": "Return TileJSON document for a dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getTileJSON",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier selecting one of the TileMatrixSetId supported.",
"title": "Tilematrixsetid"
},
"description": "Identifier selecting one of the TileMatrixSetId supported."
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "tilesize",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Tilesize in pixels. Default to 512.",
"default": 512,
"title": "Tilesize"
},
"description": "Tilesize in pixels. Default to 512."
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Tile Format"
},
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)."
},
{
"name": "minzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default minzoom.",
"title": "Minzoom"
},
"description": "Overwrite default minzoom."
},
{
"name": "maxzoom",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Overwrite default maxzoom.",
"title": "Maxzoom"
},
"description": "Overwrite default maxzoom."
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return a tilejson",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileJSON"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/point/{lon},{lat}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Point",
"description": "Get Point value for a dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getDataForPoint",
"parameters": [
{
"name": "lon",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Longitude",
"title": "Lon"
},
"description": "Longitude"
},
{
"name": "lat",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Latitude",
"title": "Lat"
},
"description": "Latitude"
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
}
],
"responses": {
"200": {
"description": "Return a value for a point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/titiler__core__models__responses__Point"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/preview/{width}x{height}.{format}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Preview",
"description": "Create preview of a dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getPreviewWithSizeAndFormat",
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "height",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"description": "Maximum image size to read onto.",
"default": 1024,
"title": "Max Size"
}
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/preview.{format}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Preview",
"description": "Create preview of a dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getPreviewWithFormat",
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"description": "Maximum image size to read onto.",
"default": 1024,
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/preview": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Preview",
"description": "Create preview of a dataset.",
"operationId": ".collections.{collection_id}.items.{item_id}.getPreview",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"description": "Maximum image size to read onto.",
"default": 1024,
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/bbox/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Bbox Image",
"description": "Create image from a bbox.",
"operationId": ".collections.{collection_id}.items.{item_id}.getDataForBoundingBoxWithSizesAndFormat",
"parameters": [
{
"name": "minx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min X",
"title": "Minx"
},
"description": "Bounding box min X"
},
{
"name": "miny",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min Y",
"title": "Miny"
},
"description": "Bounding box min Y"
},
{
"name": "maxx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max X",
"title": "Maxx"
},
"description": "Bounding box max X"
},
{
"name": "maxy",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max Y",
"title": "Maxy"
},
"description": "Bounding box max Y"
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "height",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/bbox/{minx},{miny},{maxx},{maxy}.{format}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Bbox Image",
"description": "Create image from a bbox.",
"operationId": ".collections.{collection_id}.items.{item_id}.getDataForBoundingBoxWithFormat",
"parameters": [
{
"name": "minx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min X",
"title": "Minx"
},
"description": "Bounding box min X"
},
{
"name": "miny",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box min Y",
"title": "Miny"
},
"description": "Bounding box min Y"
},
{
"name": "maxx",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max X",
"title": "Maxx"
},
"description": "Bounding box max X"
},
{
"name": "maxy",
"in": "path",
"required": true,
"schema": {
"type": "number",
"description": "Bounding box max Y",
"title": "Maxy"
},
"description": "Bounding box max Y"
},
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/feature/{width}x{height}.{format}": {
"post": {
"tags": [
"STAC Item"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".collections.{collection_id}.items.{item_id}.postDataForGeoJSONWithSizesAndFormat",
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "height",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/feature.{format}": {
"post": {
"tags": [
"STAC Item"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".collections.{collection_id}.items.{item_id}.postDataForGeoJSONWithFormat",
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/feature": {
"post": {
"tags": [
"STAC Item"
],
"summary": "Feature Image",
"description": "Create image from a geojson feature.",
"operationId": ".collections.{collection_id}.items.{item_id}.postDataForGeoJSON",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageType"
},
{
"type": "null"
}
],
"description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).",
"title": "Format"
}
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "max_size",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Maximum image size to read onto.",
"title": "Max Size"
}
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image height.",
"title": "Height"
}
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Force output image width.",
"title": "Width"
}
},
{
"name": "coord_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.",
"title": "Coord Crs"
},
"description": "Coordinate Reference System of the input coords. Default to `epsg:4326`."
},
{
"name": "dst_crs",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Output Coordinate Reference System.",
"title": "Dst Crs"
},
"description": "Output Coordinate Reference System."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Feature",
"description": "GeoJSON Feature."
}
}
}
},
"responses": {
"200": {
"description": "Return an image.",
"content": {
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/WMTSCapabilities.xml": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Wmts",
"description": "OGC RESTful WMTS endpoint.",
"operationId": ".collections.{collection_id}.items.{item_id}.getWMTS",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
},
{
"name": "tile_format",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ImageType",
"description": "Output image type. Default is png.",
"default": "png"
},
"description": "Output image type. Default is png."
},
{
"name": "use_epsg",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)",
"default": false,
"title": "Use Epsg"
},
"description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)"
},
{
"name": "buffer",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile buffer.",
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
"description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)."
},
{
"name": "padding",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Tile padding.",
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
"description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`."
},
{
"name": "assets",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Asset names",
"description": "Asset's names."
},
"description": "Asset's names.",
"examples": {
"user-provided": {},
"one-asset": {
"description": "Return results for asset `data`.",
"value": [
"data"
]
},
"multi-assets": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data",
"cog"
]
},
"multi-assets-with-options": {
"description": "Return results for assets `data` and `cog`.",
"value": [
"data|bidx=1",
"cog|bidx=1,2"
]
}
}
},
{
"name": "expression",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Band Math expression",
"description": "rio-tiler's band math expression"
},
"description": "rio-tiler's band math expression",
"examples": {
"user-provided": {},
"simple": {
"description": "Simple band math.",
"value": "b1/b2"
},
"multi-bands": {
"description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).",
"value": "b1/b2;b2+b3"
}
}
},
{
"name": "asset_as_band",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Consider asset as a 1 band dataset",
"description": "Asset as Band"
},
"description": "Asset as Band"
},
{
"name": "nodata",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nan",
"inf",
"-inf"
],
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata value",
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
"description": "Overwrite internal Nodata value; nan or valid float values only."
},
{
"name": "unscale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Apply internal Scale/Offset",
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
"description": "Apply internal Scale/Offset. Defaults to `False`."
},
{
"name": "resampling",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"gauss",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "RasterIO resampling algorithm. Defaults to `nearest`.",
"title": "Resampling"
},
"description": "RasterIO resampling algorithm. Defaults to `nearest`."
},
{
"name": "reproject",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"nearest",
"bilinear",
"cubic",
"cubic_spline",
"lanczos",
"average",
"mode",
"max",
"min",
"med",
"q1",
"q3",
"sum",
"rms"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.",
"title": "Reproject"
},
"description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`."
},
{
"name": "algorithm",
"in": "query",
"required": false,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithm"
},
"description": "Algorithm name"
},
{
"name": "algorithm_params",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Algorithm parameter",
"title": "Algorithm Params"
},
"description": "Algorithm parameter"
},
{
"name": "colormap_name",
"in": "query",
"required": false,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "Colormap name",
"title": "Colormap Name"
},
"description": "Colormap name"
},
{
"name": "colormap",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON encoded custom Colormap",
"title": "Colormap"
},
"description": "JSON encoded custom Colormap"
},
{
"name": "rescale",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Min/Max data Rescaling",
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
"examples": [
"0,2000",
"0,1000",
"0,10000"
]
},
"description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands."
},
{
"name": "color_formula",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula",
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
"description": "rio-color formula (info: https://github.com/mapbox/rio-color)"
},
{
"name": "return_mask",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Add mask to the output data. Defaults to `True`",
"title": "Return Mask"
},
"description": "Add mask to the output data. Defaults to `True`"
}
],
"responses": {
"200": {
"description": "Return RESTful WMTS service capabilities document.",
"content": {
"application/xml": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/renders": {
"get": {
"tags": [
"STAC Item"
],
"summary": "List Stac Renders Metadata",
"operationId": ".collections.{collection_id}.items.{item_id}.getRenderList",
"parameters": [
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenderItemList"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/{collection_id}/items/{item_id}/renders/{render_id}": {
"get": {
"tags": [
"STAC Item"
],
"summary": "Stac Renders Metadata",
"operationId": ".collections.{collection_id}.items.{item_id}.getRender",
"parameters": [
{
"name": "render_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "render id",
"title": "Render Id"
},
"description": "render id"
},
{
"name": "collection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Collection Identifier",
"title": "Collection Id"
},
"description": "STAC Collection Identifier"
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "STAC Item Identifier",
"title": "Item Id"
},
"description": "STAC Item Identifier"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenderItemWithLinks"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/tileMatrixSets": {
"get": {
"tags": [
"Tiling Schemes"
],
"summary": "Retrieve the list of available tiling schemes (tile matrix sets).",
"description": "OGC Specification: http://docs.opengeospatial.org/per/19-069.html#_tilematrixsets",
"operationId": "getTileMatrixSetsList",
"parameters": [
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileMatrixSetList"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/tileMatrixSets/{tileMatrixSetId}": {
"get": {
"tags": [
"Tiling Schemes"
],
"summary": "Retrieve the definition of the specified tiling scheme (tile matrix set).",
"description": "OGC Specification: http://docs.opengeospatial.org/per/19-069.html#_tilematrixset",
"operationId": "getTileMatrixSet",
"parameters": [
{
"name": "tileMatrixSetId",
"in": "path",
"required": true,
"schema": {
"enum": [
"CDB1GlobalGrid",
"CanadianNAD83_LCC",
"EuropeanETRS89_LAEAQuad",
"GNOSISGlobalGrid",
"LINZAntarticaMapTilegrid",
"NZTM2000Quad",
"UPSAntarcticWGS84Quad",
"UPSArcticWGS84Quad",
"UTM31WGS84Quad",
"WGS1984Quad",
"WebMercatorQuad",
"WorldCRS84Quad",
"WorldMercatorWGS84Quad"
],
"type": "string",
"description": "Identifier for a supported TileMatrixSet.",
"title": "Tilematrixsetid"
},
"description": "Identifier for a supported TileMatrixSet."
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TileMatrixSet"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/algorithms": {
"get": {
"tags": [
"Algorithms"
],
"summary": "Retrieve the list of available Algorithms.",
"description": "Retrieve the list of available Algorithms.",
"operationId": "getAlgorithmList",
"parameters": [
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlgorithmtList"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/algorithms/{algorithmId}": {
"get": {
"tags": [
"Algorithms"
],
"summary": "Retrieve the metadata of the specified algorithm.",
"description": "Retrieve the metadata of the specified algorithm.",
"operationId": "getAlgorithm",
"parameters": [
{
"name": "algorithmId",
"in": "path",
"required": true,
"schema": {
"enum": [
"hillshade",
"slope",
"contours",
"normalizedIndex",
"terrarium",
"terrainrgb",
"cast",
"ceil",
"floor",
"min",
"max",
"median",
"mean",
"std",
"var",
"sum",
"grayscale",
"bitonal"
],
"type": "string",
"description": "Algorithm name",
"title": "Algorithmid"
},
"description": "Algorithm name"
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlgorithmMetadata"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/colorMaps": {
"get": {
"tags": [
"ColorMaps"
],
"summary": "Retrieve the list of available colormaps.",
"description": "Retrieve the list of available colormaps.",
"operationId": "getColorMapList",
"parameters": [
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ColorMapList"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/colorMaps/{colorMapId}": {
"get": {
"tags": [
"ColorMaps"
],
"summary": "Retrieve the colorMap metadata or image.",
"description": "Retrieve the metadata of the specified colormap.",
"operationId": "getColorMap",
"parameters": [
{
"name": "colorMapId",
"in": "path",
"required": true,
"schema": {
"enum": [
"jet_r",
"haline",
"gist_ncar_r",
"algae",
"cividis_r",
"seismic_r",
"pink_r",
"rdylbu",
"inferno_r",
"deep",
"rdgy_r",
"tab10",
"bugn_r",
"ocean_r",
"purples",
"pastel1_r",
"thermal_r",
"ylorrd_r",
"wistia_r",
"cmrmap",
"pubu",
"rain",
"ylgnbu",
"gnuplot",
"gnbu",
"gist_gray_r",
"greens",
"purd_r",
"oxy_r",
"matter",
"summer_r",
"gnuplot_r",
"gnuplot2",
"solar",
"jet",
"ylgn_r",
"dark2_r",
"spring",
"tab20c",
"gist_stern",
"bwr",
"ylgn",
"plasma",
"pastel2",
"blues_r",
"rain_r",
"set1",
"topo_r",
"gist_ncar",
"turbid",
"magma_r",
"pastel2_r",
"purd",
"gnbu_r",
"spring_r",
"rdbu_r",
"ylorbr",
"twilight_shifted",
"rplumbo",
"winter_r",
"tab20b",
"ylorrd",
"copper",
"flag_r",
"afmhot",
"twilight_shifted_r",
"oranges_r",
"bone",
"seismic",
"gray_r",
"tarn_r",
"bwr_r",
"magma",
"paired_r",
"dark2",
"binary",
"set3",
"viridis_r",
"spectral",
"prgn",
"diff",
"hot",
"gist_earth",
"cubehelix",
"dense_r",
"coolwarm",
"pubugn_r",
"autumn_r",
"gnuplot2_r",
"cividis",
"bugn",
"deep_r",
"prgn_r",
"gist_rainbow",
"gist_heat_r",
"nipy_spectral_r",
"tab20",
"turbo_r",
"pubugn",
"set2_r",
"gist_yarg_r",
"spectral_r",
"binary_r",
"greys",
"rainbow_r",
"haline_r",
"curl",
"tab20c_r",
"blues",
"prism",
"rdgy",
"gist_gray",
"set2",
"cool",
"afmhot_r",
"bone_r",
"paired",
"oranges",
"orrd",
"puor",
"autumn",
"delta_r",
"pubu_r",
"piyg_r",
"turbo",
"greys_r",
"accent",
"turbid_r",
"algae_r",
"solar_r",
"topo",
"cool_r",
"inferno",
"balance",
"tempo_r",
"amp_r",
"flag",
"speed",
"gist_heat",
"balance_r",
"viridis",
"cubehelix_r",
"ylorbr_r",
"summer",
"coolwarm_r",
"diff_r",
"rdylgn_r",
"gist_stern_r",
"plasma_r",
"copper_r",
"oxy",
"gist_yarg",
"twilight",
"winter",
"brbg",
"reds_r",
"speed_r",
"rainbow",
"ice",
"nipy_spectral",
"piyg",
"gray",
"reds",
"terrain",
"tab20_r",
"wistia",
"accent_r",
"thermal",
"ocean",
"twilight_r",
"hot_r",
"set3_r",
"hsv_r",
"brg_r",
"gist_rainbow_r",
"phase",
"bupu",
"pastel1",
"dense",
"set1_r",
"phase_r",
"matter_r",
"greens_r",
"cfastie",
"tab10_r",
"rdbu",
"brg",
"rdpu_r",
"brbg_r",
"cmrmap_r",
"prism_r",
"purples_r",
"gist_earth_r",
"tempo",
"schwarzwald",
"rdpu",
"orrd_r",
"tarn",
"puor_r",
"bupu_r",
"rdylgn",
"ice_r",
"pink",
"terrain_r",
"amp",
"tab20b_r",
"rdylbu_r",
"hsv",
"curl_r",
"delta",
"ylgnbu_r"
],
"type": "string",
"description": "ColorMap name",
"title": "Colormapid"
},
"description": "ColorMap name"
},
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json",
"png",
"npy",
"tif",
"tiff",
"jpeg",
"jpg",
"jp2",
"webp",
"pngraw"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
},
{
"name": "orientation",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"vertical",
"horizontal"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Image Orientation.",
"title": "Orientation"
},
"description": "Image Orientation."
},
{
"name": "height",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Image Height (default to 20px for horizontal or 256px for vertical).",
"title": "Height"
},
"description": "Image Height (default to 20px for horizontal or 256px for vertical)."
},
{
"name": "width",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Image Width (default to 256px for horizontal or 20px for vertical).",
"title": "Width"
},
"description": "Image Width (default to 256px for horizontal or 20px for vertical)."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "array",
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
],
"minItems": 4,
"maxItems": 4
}
},
{
"type": "array",
"items": {
"type": "array",
"prefixItems": [
{
"type": "array",
"prefixItems": [
{
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
},
{
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
],
"minItems": 2,
"maxItems": 2
},
{
"type": "array",
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
],
"minItems": 4,
"maxItems": 4
}
],
"minItems": 2,
"maxItems": 2
}
}
],
"title": "Response Getcolormap"
}
},
"image/png": {},
"image/jpeg": {},
"image/jpg": {},
"image/webp": {},
"image/jp2": {},
"image/tiff; application=geotiff": {},
"application/x-binary": {},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/healthz": {
"get": {
"tags": [
"Health Check"
],
"summary": "Ping",
"description": "Health Check",
"operationId": "ping_healthz_get",
"parameters": [
{
"name": "timeout",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"description": "Timeout getting SQL connection from the pool.",
"default": 1,
"title": "Timeout"
},
"description": "Timeout getting SQL connection from the pool."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Response Ping Healthz Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/": {
"get": {
"tags": [
"OGC Common"
],
"summary": "Landing",
"description": "TiTiler landing page.",
"operationId": "landing__get",
"parameters": [
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Landing"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/conformance": {
"get": {
"tags": [
"OGC Common"
],
"summary": "Conformance",
"description": "Conformance classes.\n\nCalled with `GET /conformance`.\n\nReturns:\n Conformance classes which the server conforms to.",
"operationId": "conformance_conformance_get",
"parameters": [
{
"name": "f",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"html",
"json"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.",
"title": "F"
},
"description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Conformance"
}
},
"text/html": {}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AlgorithmMetadata": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"inputs": {
"additionalProperties": true,
"type": "object",
"title": "Inputs"
},
"outputs": {
"additionalProperties": true,
"type": "object",
"title": "Outputs"
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters"
}
},
"type": "object",
"required": [
"inputs",
"outputs",
"parameters"
],
"title": "AlgorithmMetadata",
"description": "Algorithm metadata."
},
"AlgorithmRef": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"links": {
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"title": "Links"
}
},
"type": "object",
"required": [
"id",
"links"
],
"title": "AlgorithmRef",
"description": "AlgorithmRef model."
},
"AlgorithmtList": {
"properties": {
"algorithms": {
"items": {
"$ref": "#/components/schemas/AlgorithmRef"
},
"type": "array",
"title": "Algorithms"
}
},
"type": "object",
"required": [
"algorithms"
],
"title": "AlgorithmtList",
"description": "AlgorithmList model."
},
"AssetPoint": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"values": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Values"
},
"band_names": {
"items": {
"type": "string"
},
"type": "array",
"title": "Band Names"
},
"band_descriptions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Band Descriptions"
}
},
"type": "object",
"required": [
"name",
"values",
"band_names"
],
"title": "AssetPoint",
"description": "Model for Point value per asset"
},
"BandStatistics": {
"properties": {
"min": {
"type": "number",
"title": "Min"
},
"max": {
"type": "number",
"title": "Max"
},
"mean": {
"type": "number",
"title": "Mean"
},
"count": {
"type": "number",
"title": "Count"
},
"sum": {
"type": "number",
"title": "Sum"
},
"std": {
"type": "number",
"title": "Std"
},
"median": {
"type": "number",
"title": "Median"
},
"majority": {
"type": "number",
"title": "Majority"
},
"minority": {
"type": "number",
"title": "Minority"
},
"unique": {
"type": "number",
"title": "Unique"
},
"histogram": {
"items": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
},
"type": "array"
},
"type": "array",
"title": "Histogram"
},
"valid_percent": {
"type": "number",
"title": "Valid Percent"
},
"masked_pixels": {
"type": "number",
"title": "Masked Pixels"
},
"valid_pixels": {
"type": "number",
"title": "Valid Pixels"
},
"description": {
"type": "string",
"title": "Description"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"histogram",
"valid_percent",
"masked_pixels",
"valid_pixels",
"description"
],
"title": "BandStatistics",
"description": "Band statistics"
},
"BaseModel": {
"properties": {},
"type": "object",
"title": "BaseModel"
},
"BoundingBox": {
"properties": {
"lowerLeft": {
"items": {
"type": "number"
},
"type": "array",
"maxItems": 2,
"minItems": 2,
"title": "Lowerleft",
"description": "A 2D Point in the CRS indicated elsewhere"
},
"upperRight": {
"items": {
"type": "number"
},
"type": "array",
"maxItems": 2,
"minItems": 2,
"title": "Upperright",
"description": "A 2D Point in the CRS indicated elsewhere"
},
"crs": {
"anyOf": [
{
"$ref": "#/components/schemas/CRS"
},
{
"type": "null"
}
],
"title": "CRS"
},
"orderedAxes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array",
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"title": "Orderedaxes"
}
},
"type": "object",
"required": [
"lowerLeft",
"upperRight"
],
"title": "BoundingBox",
"description": "BoundingBox model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/2DBoundingBox.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"CRS": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CRSUri"
},
{
"$ref": "#/components/schemas/CRSWKT"
},
{
"$ref": "#/components/schemas/CRSRef"
}
],
"title": "CRS",
"description": "CRS model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/common-geodata/crs.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"CRSRef": {
"properties": {
"referenceSystem": {
"additionalProperties": true,
"type": "object",
"title": "Referencesystem",
"description": "A reference system data structure as defined in the MD_ReferenceSystem of the ISO 19115"
}
},
"type": "object",
"required": [
"referenceSystem"
],
"title": "CRSRef",
"description": "CRS from referenceSystem."
},
"CRSUri": {
"properties": {
"uri": {
"type": "string",
"minLength": 1,
"format": "uri",
"title": "Uri",
"description": "Reference to one coordinate reference system (CRS) as URI",
"exemples": [
"http://www.opengis.net/def/crs/EPSG/0/3978",
"urn:ogc:def:crs:EPSG::2193"
]
}
},
"type": "object",
"required": [
"uri"
],
"title": "CRSUri",
"description": "Coordinate Reference System (CRS) from URI."
},
"CRSWKT": {
"properties": {
"wkt": {
"additionalProperties": true,
"type": "object",
"title": "Wkt",
"description": "An object defining the CRS using the JSON encoding for Well-known text representation of coordinate reference systems 2.0"
}
},
"type": "object",
"required": [
"wkt"
],
"title": "CRSWKT",
"description": "Coordinate Reference System (CRS) from WKT encoded as PROJJSON Object."
},
"ColorMapList": {
"properties": {
"colormaps": {
"items": {
"$ref": "#/components/schemas/ColorMapRef"
},
"type": "array",
"title": "Colormaps"
}
},
"type": "object",
"required": [
"colormaps"
],
"title": "ColorMapList",
"description": "Model for colormap list."
},
"ColorMapRef": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"links": {
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"title": "Links"
}
},
"type": "object",
"required": [
"id",
"links"
],
"title": "ColorMapRef",
"description": "ColorMapRef model."
},
"Conformance": {
"properties": {
"conformsTo": {
"items": {
"type": "string"
},
"type": "array",
"title": "Conformsto"
}
},
"type": "object",
"required": [
"conformsTo"
],
"title": "Conformance",
"description": "Conformance model.\n\nRef: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/confClasses.yaml"
},
"Context": {
"properties": {
"returned": {
"type": "integer",
"title": "Returned"
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Limit"
},
"matched": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Matched"
}
},
"type": "object",
"required": [
"returned"
],
"title": "Context",
"description": "Context Model."
},
"Feature": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "Feature",
"title": "Type"
},
"geometry": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Point-Input"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Input"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Input",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/Point-Input",
"Polygon": "#/components/schemas/Polygon"
}
}
},
{
"type": "null"
}
],
"title": "Geometry"
},
"properties": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"$ref": "#/components/schemas/BaseModel"
},
{
"type": "null"
}
],
"title": "Properties"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
}
},
"type": "object",
"required": [
"type",
"geometry",
"properties"
],
"title": "Feature",
"description": "Feature Model"
},
"FeatureCollection": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "FeatureCollection",
"title": "Type"
},
"features": {
"items": {
"$ref": "#/components/schemas/Feature"
},
"type": "array",
"title": "Features"
}
},
"type": "object",
"required": [
"type",
"features"
],
"title": "FeatureCollection",
"description": "FeatureCollection Model"
},
"FeatureCollection_Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type_____StatisticsInGeoJSON__": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "FeatureCollection",
"title": "Type"
},
"features": {
"items": {
"$ref": "#/components/schemas/Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_"
},
"type": "array",
"title": "Features"
}
},
"type": "object",
"required": [
"type",
"features"
],
"title": "FeatureCollection[Feature[Annotated[Union[Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection], FieldInfo(annotation=NoneType, required=True, discriminator='type')], StatisticsInGeoJSON]]"
},
"Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "Feature",
"title": "Type"
},
"geometry": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/geojson_pydantic__geometries__Point"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Output"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Output",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/geojson_pydantic__geometries__Point",
"Polygon": "#/components/schemas/Polygon"
}
}
},
{
"type": "null"
}
],
"title": "Geometry"
},
"properties": {
"anyOf": [
{
"$ref": "#/components/schemas/StatisticsInGeoJSON"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
}
},
"type": "object",
"required": [
"type",
"geometry",
"properties"
],
"title": "Feature[Annotated[Union[Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection], FieldInfo(annotation=NoneType, required=True, discriminator='type')], StatisticsInGeoJSON]"
},
"Feature_Union_Polygon__MultiPolygon__dict_str__Info__": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "Feature",
"title": "Type"
},
"geometry": {
"anyOf": [
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"type": "null"
}
],
"title": "Geometry"
},
"properties": {
"anyOf": [
{
"additionalProperties": {
"$ref": "#/components/schemas/rio_tiler__models__Info"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Properties"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
}
},
"type": "object",
"required": [
"type",
"geometry",
"properties"
],
"title": "Feature[Union[Polygon, MultiPolygon], dict[str, Info]]"
},
"GeometryCollection-Input": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "GeometryCollection",
"title": "Type"
},
"geometries": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Point-Input"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Input"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Input",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/Point-Input",
"Polygon": "#/components/schemas/Polygon"
}
}
},
"type": "array",
"title": "Geometries"
}
},
"type": "object",
"required": [
"type",
"geometries"
],
"title": "GeometryCollection",
"description": "GeometryCollection Model"
},
"GeometryCollection-Output": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "GeometryCollection",
"title": "Type"
},
"geometries": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/geojson_pydantic__geometries__Point"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Output"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Output",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/geojson_pydantic__geometries__Point",
"Polygon": "#/components/schemas/Polygon"
}
}
},
"type": "array",
"title": "Geometries"
}
},
"type": "object",
"required": [
"type",
"geometries"
],
"title": "GeometryCollection",
"description": "GeometryCollection Model"
},
"GeospatialData": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "Title of this tile matrix set, normally used for display to a human"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Brief narrative description of this tile matrix set, normally available for display to a human"
},
"keywords": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Keywords",
"description": "Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this layer"
},
"id": {
"type": "string",
"title": "Id",
"description": "Unique identifier of the Layer. Implementation of 'identifier'"
},
"dataType": {
"type": "string",
"enum": [
"map",
"vector",
"coverage"
],
"title": "Datatype",
"description": "Type of data represented in the tileset"
},
"geometryDimension": {
"anyOf": [
{
"type": "integer",
"maximum": 3.0,
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Geometrydimension",
"description": "The geometry dimension of the features shown in this layer (0: points, 1: curves, 2: surfaces, 3: solids), unspecified: mixed or unknown"
},
"featureType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Featuretype",
"description": "Feature type identifier. Only applicable to layers of datatype 'geometries'"
},
"attribution": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Attribution",
"description": "Short reference to recognize the author or provider"
},
"license": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License",
"description": "License applicable to the tiles"
},
"pointOfContact": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pointofcontact",
"description": "Useful information to contact the authors or custodians for the layer (e.g. e-mail address, a physical address, phone numbers, etc)"
},
"publisher": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publisher",
"description": "Organization or individual responsible for making the layer available"
},
"theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Theme",
"description": "Category where the layer can be grouped"
},
"crs": {
"anyOf": [
{
"$ref": "#/components/schemas/CRS"
},
{
"type": "null"
}
],
"title": "CRS"
},
"epoch": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Epoch",
"description": "Epoch of the Coordinate Reference System (CRS)"
},
"minScaleDenominator": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minscaledenominator",
"description": "Minimum scale denominator for usage of the layer"
},
"maxScaleDenominator": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxscaledenominator",
"description": "Maximum scale denominator for usage of the layer"
},
"minCellSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Mincellsize",
"description": "Minimum cell size for usage of the layer"
},
"maxCellSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxcellsize",
"description": "Maximum cell size for usage of the layer"
},
"maxTileMatrix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maxtilematrix",
"description": "TileMatrix identifier associated with the minScaleDenominator"
},
"minTileMatrix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mintilematrix",
"description": "TileMatrix identifier associated with the maxScaleDenominator"
},
"boundingBox": {
"anyOf": [
{
"$ref": "#/components/schemas/BoundingBox"
},
{
"type": "null"
}
]
},
"created": {
"anyOf": [
{
"$ref": "#/components/schemas/TimeStamp"
},
{
"type": "null"
}
]
},
"updated": {
"anyOf": [
{
"$ref": "#/components/schemas/TimeStamp"
},
{
"type": "null"
}
]
},
"style": {
"anyOf": [
{
"$ref": "#/components/schemas/Style"
},
{
"type": "null"
}
]
},
"geoDataClasses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Geodataclasses",
"description": "URI identifying a class of data contained in this layer (useful to determine compatibility with styles or processes)"
},
"propertiesSchema": {
"anyOf": [
{
"$ref": "#/components/schemas/PropertiesSchema"
},
{
"type": "null"
}
]
},
"links": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"minItems": 1
},
{
"type": "null"
}
],
"title": "Links",
"description": "Links related to this layer. Possible link 'rel' values are: 'geodata' for a URL pointing to the collection of geospatial data."
}
},
"type": "object",
"required": [
"id",
"dataType"
],
"title": "GeospatialData",
"description": "Geospatial model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/geospatialData.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"ImageType": {
"type": "string",
"enum": [
"png",
"npy",
"tif",
"tiff",
"jpeg",
"jpg",
"jp2",
"webp",
"pngraw"
],
"title": "ImageType",
"description": "Available Output image type."
},
"Infos": {
"properties": {
"searches": {
"items": {
"$ref": "#/components/schemas/titiler__pgstac__model__Info"
},
"type": "array",
"title": "Searches"
},
"links": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/titiler__pgstac__model__Link"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Links"
},
"context": {
"$ref": "#/components/schemas/Context"
}
},
"type": "object",
"required": [
"searches",
"context"
],
"title": "Infos",
"description": "Response model for /list endpoint."
},
"Landing": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"links": {
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"title": "Links"
}
},
"type": "object",
"required": [
"links"
],
"title": "Landing",
"description": "Landing page model.\n\nRef: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/landingPage.yaml"
},
"LayerJSON": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"fields": {
"additionalProperties": true,
"type": "object",
"title": "Fields"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"minzoom": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minzoom"
},
"maxzoom": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Maxzoom"
}
},
"type": "object",
"required": [
"id"
],
"title": "LayerJSON",
"description": "https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#33-vector_layers"
},
"LineString": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "LineString",
"title": "Type"
},
"coordinates": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Position2D"
},
{
"$ref": "#/components/schemas/Position3D"
}
]
},
"type": "array",
"minItems": 2,
"title": "Coordinates"
}
},
"type": "object",
"required": [
"type",
"coordinates"
],
"title": "LineString",
"description": "LineString Model"
},
"MediaType": {
"type": "string",
"enum": [
"image/tiff; application=geotiff",
"image/tiff; application=geotiff",
"image/jp2",
"image/png",
"image/png",
"image/jpeg",
"image/jpg",
"image/webp",
"application/x-binary",
"application/xml",
"application/json",
"application/geo+json",
"text/html",
"text/plain",
"application/x-protobuf",
"application/vnd.mapbox-vector-tile",
"application/ndjson",
"application/geo+json-seq",
"application/schema+json",
"text/csv",
"application/vnd.oai.openapi+json;version=3.0",
"application/vnd.oai.openapi;version=3.0",
"image/gif"
],
"title": "MediaType",
"description": "Responses Media types formerly known as MIME types."
},
"Metadata": {
"properties": {
"type": {
"type": "string",
"enum": [
"mosaic",
"search"
],
"title": "Type",
"default": "mosaic"
},
"bounds": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bounds"
},
"minzoom": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minzoom"
},
"maxzoom": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Maxzoom"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"assets": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Assets"
},
"defaults": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Defaults"
}
},
"additionalProperties": true,
"type": "object",
"title": "Metadata",
"description": "Metadata Model."
},
"MultiLineString": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "MultiLineString",
"title": "Type"
},
"coordinates": {
"items": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Position2D"
},
{
"$ref": "#/components/schemas/Position3D"
}
]
},
"type": "array",
"minItems": 2
},
"type": "array",
"title": "Coordinates"
}
},
"type": "object",
"required": [
"type",
"coordinates"
],
"title": "MultiLineString",
"description": "MultiLineString Model"
},
"MultiPoint": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "MultiPoint",
"title": "Type"
},
"coordinates": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Position2D"
},
{
"$ref": "#/components/schemas/Position3D"
}
]
},
"type": "array",
"title": "Coordinates"
}
},
"type": "object",
"required": [
"type",
"coordinates"
],
"title": "MultiPoint",
"description": "MultiPoint Model"
},
"MultiPolygon": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "MultiPolygon",
"title": "Type"
},
"coordinates": {
"items": {
"items": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Position2D"
},
{
"$ref": "#/components/schemas/Position3D"
}
]
},
"type": "array",
"minItems": 4
},
"type": "array"
},
"type": "array",
"title": "Coordinates"
}
},
"type": "object",
"required": [
"type",
"coordinates"
],
"title": "MultiPolygon",
"description": "MultiPolygon Model"
},
"Point-Input": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "Point",
"title": "Type"
},
"coordinates": {
"anyOf": [
{
"$ref": "#/components/schemas/Position2D"
},
{
"$ref": "#/components/schemas/Position3D"
}
],
"title": "Coordinates"
}
},
"type": "object",
"required": [
"type",
"coordinates"
],
"title": "Point",
"description": "Point Model"
},
"Polygon": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "Polygon",
"title": "Type"
},
"coordinates": {
"items": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Position2D"
},
{
"$ref": "#/components/schemas/Position3D"
}
]
},
"type": "array",
"minItems": 4
},
"type": "array",
"title": "Coordinates"
}
},
"type": "object",
"required": [
"type",
"coordinates"
],
"title": "Polygon",
"description": "Polygon Model"
},
"Position2D": {
"prefixItems": [
{
"type": "number",
"title": "Longitude"
},
{
"type": "number",
"title": "Latitude"
}
],
"type": "array",
"maxItems": 2,
"minItems": 2
},
"Position3D": {
"prefixItems": [
{
"type": "number",
"title": "Longitude"
},
{
"type": "number",
"title": "Latitude"
},
{
"type": "number",
"title": "Altitude"
}
],
"type": "array",
"maxItems": 3,
"minItems": 3
},
"Properties": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Implements 'description'"
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"array",
"boolean",
"integer",
"null",
"number",
"object",
"string"
]
},
{
"type": "null"
}
],
"title": "Type"
},
"enum": {
"anyOf": [
{
"items": {},
"type": "array",
"minItems": 1,
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Enum",
"description": "Implements 'acceptedValues'"
},
"format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Format",
"description": "Complements implementation of 'type'"
},
"contentMediaType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Contentmediatype",
"description": "Implements 'mediaType'"
},
"maximum": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maximum",
"description": "Implements 'range'"
},
"exclusiveMaximum": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Exclusivemaximum",
"description": "Implements 'range'"
},
"minimum": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minimum",
"description": "Implements 'range'"
},
"exclusiveMinimum": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Exclusiveminimum",
"description": "Implements 'range'"
},
"pattern": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pattern"
},
"maxItems": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Maxitems",
"description": "Implements 'upperMultiplicity'"
},
"minItems": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Minitems",
"description": "Implements 'lowerMultiplicity'",
"default": 0
},
"observedProperty": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Observedproperty"
},
"observedPropertyURI": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Observedpropertyuri"
},
"uom": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Uom"
},
"uomURI": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Uomuri"
}
},
"type": "object",
"title": "Properties",
"description": "Properties model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/propertiesSchema.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"PropertiesSchema": {
"properties": {
"type": {
"type": "string",
"const": "object",
"title": "Type"
},
"required": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array",
"minItems": 1
},
{
"type": "null"
}
],
"title": "Required",
"description": "Implements 'multiplicity' by citing property 'name' defined as 'additionalProperties'"
},
"properties": {
"additionalProperties": {
"$ref": "#/components/schemas/Properties"
},
"type": "object",
"title": "Properties"
}
},
"type": "object",
"required": [
"type",
"properties"
],
"title": "PropertiesSchema",
"description": "PropertiesSchema model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/propertiesSchema.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"RegisterMosaic": {
"properties": {
"collections": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Collections"
},
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids"
},
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"intersects": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Point-Input"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Input"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Input",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/Point-Input",
"Polygon": "#/components/schemas/Polygon"
}
}
},
{
"type": "null"
}
],
"title": "Intersects"
},
"datetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Datetime"
},
"query": {
"anyOf": [
{
"additionalProperties": {
"additionalProperties": true,
"propertyNames": {
"enum": [
"eq",
"neq",
"lt",
"lte",
"gt",
"gte"
]
},
"type": "object"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Query"
},
"sortby": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SortExtension"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sortby",
"description": "An array of property (field) names, and direction in form of '{'field': '', 'direction':''}'",
"examples": [
null,
[
{
"direction": "asc",
"field": "properties.created"
}
]
]
},
"filter": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "A CQL filter expression for filtering items.",
"examples": [
null,
{
"args": [
{
"args": [
{
"property": "id"
},
"LC08_L1TP_060247_20180905_20180912_01_T1_L1TP"
],
"op": "="
},
{
"args": [
{
"property": "collection"
},
"landsat8_l1tp"
],
"op": "="
}
],
"op": "and"
}
]
},
"filter-lang": {
"anyOf": [
{
"type": "string",
"const": "cql2-json"
},
{
"type": "null"
}
],
"title": "Filter-Lang",
"description": "The CQL filter encoding that the 'filter' value uses.",
"default": "cql2-json"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
}
},
"additionalProperties": true,
"type": "object",
"title": "RegisterMosaic",
"description": "Model of /register endpoint input."
},
"RegisterResponse": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"links": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/titiler__pgstac__model__Link"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Links"
}
},
"type": "object",
"required": [
"id"
],
"title": "RegisterResponse",
"description": "Response model for /register endpoint."
},
"RenderItem": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"assets": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Assets"
},
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expression"
},
"rescale": {
"anyOf": [
{
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Rescale"
},
"nodata": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Nodata"
},
"colormap_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Colormap Name"
},
"colormap": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Colormap"
},
"color_formula": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color Formula"
},
"resampling": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resampling"
},
"minmax_zoom": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Minmax Zoom"
}
},
"additionalProperties": true,
"type": "object",
"title": "RenderItem",
"description": "Render item for stac render extension."
},
"RenderItemList": {
"properties": {
"renders": {
"additionalProperties": {
"$ref": "#/components/schemas/RenderItemWithLinks"
},
"type": "object",
"title": "Renders"
},
"links": {
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"title": "Links"
}
},
"type": "object",
"required": [
"renders",
"links"
],
"title": "RenderItemList",
"description": "List of Render Items with links."
},
"RenderItemWithLinks": {
"properties": {
"valid": {
"type": "boolean",
"title": "Valid"
},
"params": {
"$ref": "#/components/schemas/RenderItem"
},
"links": {
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"title": "Links"
}
},
"type": "object",
"required": [
"valid",
"params",
"links"
],
"title": "RenderItemWithLinks",
"description": "Same as RenderItem with url and params."
},
"Search": {
"properties": {
"hash": {
"type": "string",
"title": "Hash"
},
"search": {
"additionalProperties": true,
"type": "object",
"title": "Search"
},
"_where": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Where"
},
"orderby": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
},
"lastused": {
"type": "string",
"format": "date-time",
"title": "Lastused"
},
"usecount": {
"type": "integer",
"title": "Usecount"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
}
},
"type": "object",
"required": [
"hash",
"search",
"lastused",
"usecount",
"metadata"
],
"title": "Search",
"description": "PgSTAC Search entry.\n\nref: https://github.com/stac-utils/pgstac/blob/3499daa2bfa700ae7bb07503795c169bf2ebafc7/sql/004_search.sql#L907-L915"
},
"SortExtension": {
"properties": {
"field": {
"type": "string",
"minLength": 1,
"title": "Field"
},
"direction": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "Direction"
}
},
"type": "object",
"required": [
"field",
"direction"
],
"title": "SortExtension",
"description": "https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension"
},
"StatisticsInGeoJSON": {
"properties": {
"statistics": {
"additionalProperties": {
"$ref": "#/components/schemas/BandStatistics"
},
"type": "object",
"title": "Statistics"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"statistics"
],
"title": "StatisticsInGeoJSON",
"description": "Statistics model in geojson response."
},
"Style": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "An identifier for this style. Implementation of 'identifier'"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "A title for this style"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Brief narrative description of this style"
},
"keywords": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Keywords",
"description": "keywords about this style"
},
"links": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"minItems": 1
},
{
"type": "null"
}
],
"title": "Links",
"description": "Links to style related resources. Possible link 'rel' values are: 'style' for a URL pointing to the style description, 'styleSpec' for a URL pointing to the specification or standard used to define the style."
}
},
"type": "object",
"required": [
"id"
],
"title": "Style",
"description": "Style model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/style.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"TMSBoundingBox": {
"properties": {
"lowerLeft": {
"prefixItems": [
{
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
},
{
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
],
"type": "array",
"maxItems": 2,
"minItems": 2,
"title": "Lowerleft",
"description": "A 2D Point in the CRS indicated elsewhere"
},
"upperRight": {
"prefixItems": [
{
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
},
{
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
],
"type": "array",
"maxItems": 2,
"minItems": 2,
"title": "Upperright",
"description": "A 2D Point in the CRS indicated elsewhere"
},
"crs": {
"anyOf": [
{
"$ref": "#/components/schemas/CRS"
},
{
"type": "null"
}
],
"description": "Coordinate Reference System (CRS)"
},
"orderedAxes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array",
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"title": "Orderedaxes",
"description": "Ordered list of names of the dimensions defined in the CRS"
}
},
"type": "object",
"required": [
"lowerLeft",
"upperRight"
],
"title": "TMSBoundingBox",
"description": "Bounding box\n\nref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/2DBoundingBox.json"
},
"TileJSON": {
"properties": {
"tilejson": {
"type": "string",
"title": "Tilejson",
"default": "3.0.0"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"version": {
"type": "string",
"title": "Version",
"default": "1.0.0"
},
"attribution": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Attribution"
},
"template": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Template"
},
"legend": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Legend"
},
"scheme": {
"type": "string",
"enum": [
"xyz",
"tms"
],
"title": "Scheme",
"default": "xyz"
},
"tiles": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tiles"
},
"vector_layers": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LayerJSON"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Vector Layers"
},
"grids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grids"
},
"data": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data"
},
"minzoom": {
"type": "integer",
"title": "Minzoom",
"default": 0
},
"maxzoom": {
"type": "integer",
"title": "Maxzoom",
"default": 30
},
"fillzoom": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Fillzoom"
},
"bounds": {
"items": {
"type": "number"
},
"type": "array",
"title": "Bounds",
"default": [
-180,
-85.0511287798066,
180,
85.0511287798066
]
},
"center": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "integer"
}
],
"type": "array",
"maxItems": 3,
"minItems": 3
},
{
"type": "null"
}
],
"title": "Center"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"tiles"
],
"title": "TileJSON",
"description": "TileJSON model.\n\nBased on https://github.com/mapbox/tilejson-spec/tree/master/3.0.0"
},
"TileMatrix": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "Title of this tile matrix, normally used for display to a human"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Brief narrative description of this tile matrix set, normally available for display to a human"
},
"keywords": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Keywords",
"description": "Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this dataset"
},
"id": {
"type": "string",
"pattern": "^\\-?[0-9]+$",
"title": "Id",
"description": "Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. Implementation of 'identifier'"
},
"scaleDenominator": {
"type": "number",
"title": "Scaledenominator",
"description": "Scale denominator of this tile matrix"
},
"cellSize": {
"type": "number",
"title": "Cellsize",
"description": "Cell size of this tile matrix"
},
"cornerOfOrigin": {
"type": "string",
"enum": [
"topLeft",
"bottomLeft"
],
"title": "Corneroforigin",
"description": "The corner of the tile matrix (_topLeft_ or _bottomLeft_) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile.",
"default": "topLeft"
},
"pointOfOrigin": {
"prefixItems": [
{
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
},
{
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
}
],
"type": "array",
"maxItems": 2,
"minItems": 2,
"title": "Pointoforigin",
"description": "Precise position in CRS coordinates of the corner of origin (e.g. the top-left corner) for this tile matrix. This position is also a corner of the (0, 0) tile. In previous version, this was 'topLeftCorner' and 'cornerOfOrigin' did not exist."
},
"tileWidth": {
"type": "integer",
"multipleOf": 1.0,
"minimum": 1.0,
"title": "Tilewidth",
"description": "Width of each tile of this tile matrix in pixels"
},
"tileHeight": {
"type": "integer",
"multipleOf": 1.0,
"minimum": 1.0,
"title": "Tileheight",
"description": "Height of each tile of this tile matrix in pixels"
},
"matrixWidth": {
"type": "integer",
"multipleOf": 1.0,
"minimum": 1.0,
"title": "Matrixwidth",
"description": "Width of the matrix (number of tiles in width)"
},
"matrixHeight": {
"type": "integer",
"multipleOf": 1.0,
"minimum": 1.0,
"title": "Matrixheight",
"description": "Height of the matrix (number of tiles in height)"
},
"variableMatrixWidths": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/variableMatrixWidth"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variablematrixwidths",
"description": "Describes the rows that has variable matrix width"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"scaleDenominator",
"cellSize",
"pointOfOrigin",
"tileWidth",
"tileHeight",
"matrixWidth",
"matrixHeight"
],
"title": "TileMatrix",
"description": "Tile Matrix Definition\n\nA tile matrix, usually corresponding to a particular zoom level of a TileMatrixSet.\n\nref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrix.json"
},
"TileMatrixLimits": {
"properties": {
"tileMatrix": {
"type": "string",
"title": "Tilematrix"
},
"minTileRow": {
"type": "integer",
"minimum": 0.0,
"title": "Mintilerow"
},
"maxTileRow": {
"type": "integer",
"minimum": 0.0,
"title": "Maxtilerow"
},
"minTileCol": {
"type": "integer",
"minimum": 0.0,
"title": "Mintilecol"
},
"maxTileCol": {
"type": "integer",
"minimum": 0.0,
"title": "Maxtilecol"
}
},
"type": "object",
"required": [
"tileMatrix",
"minTileRow",
"maxTileRow",
"minTileCol",
"maxTileCol"
],
"title": "TileMatrixLimits",
"description": "The limits for an individual tile matrix of a TileSet's TileMatrixSet, as defined in the OGC 2D TileMatrixSet and TileSet Metadata Standard\n\nBased on https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/tileMatrixLimits.yaml"
},
"TileMatrixSet": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "Title of this tile matrix set, normally used for display to a human"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Brief narrative description of this tile matrix set, normally available for display to a human"
},
"keywords": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Keywords",
"description": "Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this tile matrix set"
},
"id": {
"anyOf": [
{
"type": "string",
"pattern": "^[\\w\\d_\\-]+$"
},
{
"type": "null"
}
],
"title": "Id",
"description": "Tile matrix set identifier. Implementation of 'identifier'"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Uri",
"description": "Reference to an official source for this tileMatrixSet"
},
"orderedAxes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array",
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"title": "Orderedaxes",
"description": "Ordered list of names of the dimensions defined in the CRS"
},
"crs": {
"$ref": "#/components/schemas/CRS",
"description": "Coordinate Reference System (CRS)"
},
"wellKnownScaleSet": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Wellknownscaleset",
"description": "Reference to a well-known scale set"
},
"boundingBox": {
"anyOf": [
{
"$ref": "#/components/schemas/TMSBoundingBox"
},
{
"type": "null"
}
],
"description": "Minimum bounding rectangle surrounding the tile matrix set, in the supported CRS"
},
"tileMatrices": {
"items": {
"$ref": "#/components/schemas/TileMatrix"
},
"type": "array",
"title": "Tilematrices",
"description": "Describes scale levels and its tile matrices"
}
},
"type": "object",
"required": [
"crs",
"tileMatrices"
],
"title": "TileMatrixSet",
"description": "Tile Matrix Set Definition\n\nA definition of a tile matrix set following the Tile Matrix Set standard.\nFor tileset metadata, such a description (in `tileMatrixSet` property) is only required for offline use,\nas an alternative to a link with a `http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme` relation type.\n\nref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrixSet.json"
},
"TileMatrixSetList": {
"properties": {
"tileMatrixSets": {
"items": {
"$ref": "#/components/schemas/TileMatrixSetRef"
},
"type": "array",
"title": "Tilematrixsets"
}
},
"type": "object",
"required": [
"tileMatrixSets"
],
"title": "TileMatrixSetList",
"description": "TileMatrixSetList model.\n\nBased on http://docs.opengeospatial.org/per/19-069.html#_tilematrixsets"
},
"TileMatrixSetRef": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"links": {
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"title": "Links"
}
},
"type": "object",
"required": [
"id",
"links"
],
"title": "TileMatrixSetRef",
"description": "TileMatrixSetRef model.\n\nBased on http://docs.opengeospatial.org/per/19-069.html#_tilematrixsets"
},
"TilePoint": {
"properties": {
"coordinates": {
"items": {
"type": "number"
},
"type": "array",
"maxItems": 2,
"minItems": 2,
"title": "Coordinates"
},
"crs": {
"anyOf": [
{
"$ref": "#/components/schemas/CRS"
},
{
"type": "null"
}
],
"title": "CRS"
},
"tileMatrix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tilematrix",
"description": "TileMatrix identifier associated with the scaleDenominator"
},
"scaleDenominator": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Scaledenominator",
"description": "Scale denominator of the tile matrix selected"
},
"cellSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cellsize",
"description": "Cell size of the tile matrix selected"
}
},
"type": "object",
"required": [
"coordinates",
"crs"
],
"title": "TilePoint",
"description": "TilePoint model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/tilePoint.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"TileSet": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "A title for this tileset"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Brief narrative description of this tile set"
},
"dataType": {
"type": "string",
"enum": [
"map",
"vector",
"coverage"
],
"title": "Datatype",
"description": "Type of data represented in the tileset"
},
"crs": {
"$ref": "#/components/schemas/CRS"
},
"tileMatrixSetURI": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Tilematrixseturi",
"description": "Reference to a Tile Matrix Set on an official source for Tile Matrix Sets"
},
"links": {
"items": {
"$ref": "#/components/schemas/titiler__core__models__common__Link"
},
"type": "array",
"title": "Links",
"description": "Links to related resources"
},
"tileMatrixSetLimits": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TileMatrixLimits"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tilematrixsetlimits",
"description": "Limits for the TileRow and TileCol values for each TileMatrix in the tileMatrixSet. If missing, there are no limits other that the ones imposed by the TileMatrixSet. If present the TileMatrices listed are limited and the rest not available at all"
},
"epoch": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Epoch",
"description": "Epoch of the Coordinate Reference System (CRS)"
},
"layers": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/GeospatialData"
},
"type": "array",
"minItems": 1
},
{
"type": "null"
}
],
"title": "Layers"
},
"boundingBox": {
"anyOf": [
{
"$ref": "#/components/schemas/BoundingBox"
},
{
"type": "null"
}
]
},
"centerPoint": {
"anyOf": [
{
"$ref": "#/components/schemas/TilePoint"
},
{
"type": "null"
}
]
},
"style": {
"anyOf": [
{
"$ref": "#/components/schemas/Style"
},
{
"type": "null"
}
]
},
"attribution": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Attribution",
"description": "Short reference to recognize the author or provider"
},
"license": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License",
"description": "License applicable to the tiles"
},
"accessConstraints": {
"anyOf": [
{
"type": "string",
"enum": [
"unclassified",
"restricted",
"confidential",
"secret",
"topSecret"
]
},
{
"type": "null"
}
],
"title": "Accessconstraints",
"description": "Restrictions on the availability of the Tile Set that the user needs to be aware of before using or redistributing the Tile Set",
"default": "unclassified"
},
"keywords": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Keywords",
"description": "keywords about this tileset"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Version",
"description": "Version of the Tile Set. Changes if the data behind the tiles has been changed"
},
"created": {
"anyOf": [
{
"$ref": "#/components/schemas/TimeStamp"
},
{
"type": "null"
}
]
},
"updated": {
"anyOf": [
{
"$ref": "#/components/schemas/TimeStamp"
},
{
"type": "null"
}
]
},
"pointOfContact": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pointofcontact",
"description": "Useful information to contact the authors or custodians for the Tile Set"
},
"mediaTypes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mediatypes",
"description": "Media types available for the tiles"
}
},
"type": "object",
"required": [
"dataType",
"crs",
"links"
],
"title": "TileSet",
"description": "TileSet model.\n\nBased on https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/tileSet.yaml"
},
"TileSetList": {
"properties": {
"tilesets": {
"items": {
"$ref": "#/components/schemas/TileSet"
},
"type": "array",
"title": "Tilesets"
}
},
"type": "object",
"required": [
"tilesets"
],
"title": "TileSetList",
"description": "TileSetList model.\n\nBased on https://docs.ogc.org/is/20-057/20-057.html#toc34"
},
"TimeStamp": {
"type": "string",
"format": "date-time",
"title": "TimeStamp",
"description": "This property indicates the time and date when the response was generated using RFC 3339 notation.",
"examples": [
"2017-08-17T08:05:32Z"
]
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"geojson_pydantic__geometries__Point": {
"properties": {
"bbox": {
"anyOf": [
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
{
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 6,
"minItems": 6
},
{
"type": "null"
}
],
"title": "Bbox"
},
"type": {
"type": "string",
"const": "Point",
"title": "Type"
},
"coordinates": {
"anyOf": [
{
"$ref": "#/components/schemas/Position2D"
},
{
"$ref": "#/components/schemas/Position3D"
}
],
"title": "Coordinates"
}
},
"type": "object",
"required": [
"type",
"coordinates"
],
"title": "Point",
"description": "Point Model"
},
"rio_tiler__models__Info": {
"properties": {
"bounds": {
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4,
"title": "Bounds"
},
"crs": {
"type": "string",
"title": "Crs"
},
"band_metadata": {
"items": {
"prefixItems": [
{
"type": "string"
},
{
"additionalProperties": true,
"type": "object"
}
],
"type": "array",
"maxItems": 2,
"minItems": 2
},
"type": "array",
"title": "Band Metadata"
},
"band_descriptions": {
"items": {
"prefixItems": [
{
"type": "string"
},
{
"type": "string"
}
],
"type": "array",
"maxItems": 2,
"minItems": 2
},
"type": "array",
"title": "Band Descriptions"
},
"dtype": {
"type": "string",
"title": "Dtype"
},
"nodata_type": {
"type": "string",
"enum": [
"Alpha",
"Mask",
"Internal",
"Nodata",
"None"
],
"title": "Nodata Type"
},
"colorinterp": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Colorinterp"
},
"scales": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Scales"
},
"offsets": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Offsets"
},
"colormap": {
"anyOf": [
{
"additionalProperties": {
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Colormap"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"bounds",
"crs",
"band_metadata",
"band_descriptions",
"dtype",
"nodata_type"
],
"title": "Info",
"description": "Dataset Info."
},
"titiler__core__models__common__Link": {
"properties": {
"href": {
"type": "string",
"minLength": 1,
"format": "uri",
"title": "Href",
"description": "Supplies the URI to a remote resource (or resource fragment).",
"examples": [
"http://data.example.com/buildings/123"
]
},
"rel": {
"type": "string",
"title": "Rel",
"description": "The type or semantics of the relation.",
"examples": [
"alternate"
]
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"description": "A hint indicating what the media type of the result of dereferencing the link should be.",
"examples": [
"application/geo+json"
]
},
"templated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Templated",
"description": "This flag set to true if the link is a URL template."
},
"varBase": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Varbase",
"description": "A base path to retrieve semantic information about the variables used in URL template.",
"examples": [
"/ogcapi/vars/"
]
},
"hreflang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Hreflang",
"description": "A hint indicating what the language of the result of dereferencing the link should be.",
"examples": [
"en"
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "Used to label the destination of a link such that it can be used as a human-readable identifier.",
"examples": [
"Trierer Strasse 70, 53115 Bonn"
]
},
"length": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Length"
}
},
"type": "object",
"required": [
"href",
"rel"
],
"title": "Link",
"description": "Link model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/common-core/link.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"titiler__core__models__responses__Point": {
"properties": {
"coordinates": {
"items": {
"type": "number"
},
"type": "array",
"title": "Coordinates"
},
"values": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Values"
},
"band_names": {
"items": {
"type": "string"
},
"type": "array",
"title": "Band Names"
},
"band_descriptions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Band Descriptions"
}
},
"type": "object",
"required": [
"coordinates",
"values",
"band_names"
],
"title": "Point",
"description": "Point model.\n\nresponse model for `/point` endpoints"
},
"titiler__mosaic__models__responses__Point": {
"properties": {
"coordinates": {
"items": {
"type": "number"
},
"type": "array",
"title": "Coordinates"
},
"assets": {
"items": {
"$ref": "#/components/schemas/AssetPoint"
},
"type": "array",
"title": "Assets"
}
},
"type": "object",
"required": [
"coordinates",
"assets"
],
"title": "Point",
"description": "Point model.\n\nresponse model for `/point` endpoints"
},
"titiler__pgstac__model__Info": {
"properties": {
"search": {
"$ref": "#/components/schemas/Search"
},
"links": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/titiler__pgstac__model__Link"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Links"
}
},
"type": "object",
"required": [
"search"
],
"title": "Info",
"description": "Response model for /info endpoint."
},
"titiler__pgstac__model__Link": {
"properties": {
"href": {
"type": "string",
"title": "Href",
"description": "Supplies the URI to a remote resource (or resource fragment).",
"example": "http://data.example.com/buildings/123"
},
"rel": {
"type": "string",
"title": "Rel",
"description": "The type or semantics of the relation.",
"example": "alternate"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/MediaType"
},
{
"type": "null"
}
],
"description": "A hint indicating what the media type of the result of dereferencing the link should be.",
"example": "application/geo+json"
},
"templated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Templated",
"description": "This flag set to true if the link is a URL template."
},
"varBase": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Varbase",
"description": "A base path to retrieve semantic information about the variables used in URL template.",
"example": "/ogcapi/vars/"
},
"hreflang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Hreflang",
"description": "A hint indicating what the language of the result of dereferencing the link should be.",
"example": "en"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "Used to label the destination of a link such that it can be used as a human-readable identifier.",
"example": "Trierer Strasse 70, 53115 Bonn"
},
"length": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Length"
}
},
"type": "object",
"required": [
"href",
"rel"
],
"title": "Link",
"description": "Link model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/common-core/link.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/"
},
"variableMatrixWidth": {
"properties": {
"coalesce": {
"type": "integer",
"multipleOf": 1.0,
"minimum": 2.0,
"title": "Coalesce",
"description": "Number of tiles in width that coalesce in a single tile for these rows"
},
"minTileRow": {
"type": "integer",
"multipleOf": 1.0,
"minimum": 0.0,
"title": "Mintilerow",
"description": "First tile row where the coalescence factor applies for this tilematrix"
},
"maxTileRow": {
"type": "integer",
"multipleOf": 1.0,
"minimum": 0.0,
"title": "Maxtilerow",
"description": "Last tile row where the coalescence factor applies for this tilematrix"
}
},
"type": "object",
"required": [
"coalesce",
"minTileRow",
"maxTileRow"
],
"title": "variableMatrixWidth",
"description": "Variable Matrix Width Definition\n\nref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/variableMatrixWidth.json"
}
}
}
}