Basemaps WMS

Overview

The Basemap Web Map Service (WMS) returns a Vivid Basemap for the requested product type. The following Vivid Basemap products are available to stream.

Vivid Basemap Product	productName
Vivid Advanced 15 cm	VIVID_ADVANCED_15
Vivid Standard 30 cm	VIVID_STANDARD_30

This example shows a CQL query for Vivid Standard 30 cm basemap imagery.

cql_filter=productName='Vivid_Standard_30'

See Using CQL Filters for instructions.

Authentication

All OGC services accept an API key or a bearer token for authentication.

Bearer tokens

Maxar Oauth bearer tokens can also be used to authenticate API requests. Bearer tokens have a brief duration and must be refreshed frequently.

To authenticate with a bearer token, use the Authorization header:

Authorization: Bearer <Oauth2 token>

Learn about OAuth2 bearer tokens

API keys

API keys can be passed using query parameters or in a custom header. No Authorization header is needed when using API keys.

To use the query parameter method, include this query parameter in your request:

maxar_api_key=<your API key>

The custom Maxar header takes the form of:

maxar-api-key: <your API key>

API keys expire 180 days from creation by default. A custom expiration date can be set but cannot exceed 180 days.

Learn about API keys

Services

Name	Description	Request URL
Get Capabilities	Describes the capabilities available for WMS.	https://api.maxar.com/basemaps/v1/ogc/wms?request=GetCapabilities
Get Map	Generates a seamless image based on the input query parameters.	https://api.maxar.com/basemaps/v1/ogc/wms?request=GetMap

WMS Get Capabilities

Returns a list of services and operations supported by WMS.

Request URL

https://api.maxar.com/basemaps/v1/ogc/wms&request=GetCapabilities&version=1.3.0

Query parameters

Name	Required/Optional	Description	Value
service	required	The name of the requested OGC service.	wms
request	required	The name of the request type	GetCapabilities
version	required	The version number of the service	Use 1.3.0

Response

Response output format: XML

Successful status code: 200 OK

Exceptions may also return a 200 OK, with an error in the response body.

The response body is returned in XML format and describes the supported WMS services and imagery layers.

WMS Get Map

Generates a basemap image based on the input query parameters.

The imagery layer Maxar:Imagery includes all imagery, including the Daily Take imagery layer and the Vivid basemap layers. To restrict WMS results to Vivid basemaps, use the cql filter clause productName LIKE 'VIVID%'. To restrict to a specific Vivid product type, use a cql clause to call that product type. For example, productName='VIVID_ADVANCED_15'.

Request URL

URL path with required parameters:

Examples:

WMS example with EPSG:4326

https://api.maxar.com/basemaps/v1/ogc/wms?service=WMS&request=GetMap&version=1.3.0&bbox=39.719534,-105.009465,39.746465,-104.957624&crs=EPSG:4326&layers=Maxar:Imagery&height=512&width=512&format=image/png&cql_Filter=productName='VIVID_STANDARD_30'

WMS example with EPSG:3857

https://api.maxar.com/basemaps/v1/ogc/wms?service=WMS&request=GetMap&version=1.3.0&bbox=-11683553, 4832655,-11683247, 4832960&crs=EPSG:3857&layers=Maxar:Imagery&height=512&width=512&format=image/vnd.jpeg-png&cql_Filter=productName='VIVID_STANDARD_30'

Query parameters

Name	Required/Optional	Description	Allowed Values
service	required	The OGC service name.	WMS
request	required	The name of the WMS request type.	GetMap
version	optional	WMS version number. 1.3.0 is the latest version and is set by default. This is the recommended version.	Accepts 1.3.0 and 1.1.1
bbox	required	Your area of interest in bounding box format. The order of the bbox coordinates depends on the selected CRS projection.	See Bounding Box Coordinate Order
layers	required	The name of the imagery layer to query.	Use Maxar:Imagery
crs	required	The requested output projection.	EPSG:4326 EPSG:3857
height	required	The height of the vertical tile column	Example: 512
width	required	The width of the horizontal tile row	Example: 512
format	optional	The output file format of the response.	See Supported Output Formats
transparent	optional	Removes blank background space from returned images.	true
styles	optional	Renders the layers in the selected style.	For the Maxar:Imagery layer, the style is raster.
cql_filter	optional	Filter by feature metadata attributes. cql_filter=productName='Vivid_Standard_30'
shoreline_masking	optional	Applies a shoreline mask when set to true.	shoreline_masking=true

We recommend using the latest WMS version - 1.3.0 - unless you have a specific reason to use 1.1.1. See Differences between WMS versions in the Geoserver spec for more information.

Shoreline masking

The shoreline_masking parameter applies a shoreline mask to an image. The mask is automatically applied up to zoom level 10.

This example shows applying a shoreline mask to Vivid Standard 30 imagery. To fill out the pixels of the masked area, include the cql filter clause productName='BASE_MOSAIC.

https://api.maxar.com/basemaps/v1/ogc/wms?service=wms&request=GetMap&version=1.3.0&bbox=-13640313.39894550852,4546650.010356360115,-13636538.06416588835,4550119.459330277517&crs=EPSG:3857&layers=Maxar:Imagery&height=1719&width=1580&format=image/vnd.jpeg-png&shoreline_masking=true&cql_filter=productName='VIVID_STANDARD_30' OR productName='BASE_MOSAIC'

Bounding Box Coordinate Order

The required order of the bounding box coordinates depends on the specified CRS projection. This table shows the coordinate order for the supported projections. Click the Projection Name to view supporting documentation.

To read the coordinate order, the coordinates of a bounding box are encoded with four values in pixels: [x_min, y_min, x_max, y_max]. x_min and y_min are coordinates of the top-left corner of the bounding box.

Projection	BBox coordinate order	Example
EPSG:4326	[ymin, xmin, ymax, xmax]	39.719534,-105.009465,39.746465,-104.957624
EPSG:3857	[xmin, ymin, xmax, ymax]	-11683553, 4832655,-11683247, 48329601

Note: If you are using WMS version 1.1.1, the coordinate order for EPSG:4326 must be [xmin, ymin, xmax, ymax]. See WMS Basics: Axis ordering for a full explanation.

Supported output formats

The response to a WMS Get Feature Info query can be returned in a variety of formats. The default format is text/plain.

Supported output formats

image/png
application/atom+xml
application/json;type=utfgrid
application/pdf
application/rss+xml
application/vnd.google-earth.kml+xml
application/vnd.google-earth.kml+xml;mode=networklink
application/vnd.google-earth.kmz
image/geotiff
image/geotiff8
image/gif
image/jpeg
image/png; mode=8bit
image/svg+xml
image/tiff
image/tiff8
image/vnd.jpeg-png
image/vnd.jpeg-png8
text/html; subtype=openlayers
text/html; subtype=openlayers2
text/html; subtype=openlayers3

CQL Filters

OGC Streaming services support searching for features using Common Query Language (CQL) filters.

The query format is:

cql_filter=keyname='value'

CQL operators

Operator	Definition	Example
=	Equals	productName='VIVID_ADVANCED_15'
>	Greater Than	sunElevation>15
<	Less Than	cloudCover<.20
>=	Greater than or equal to	sunElevation>=15
<=	Less than or equal to	cloudCover<=.20
<>	Not equal to	productName<>'VIVID_BASIC'
%	Wildcard	productName LIKE 'VIVID%'

CQL search keywords

Use CQL keywords to create a complex query that joins two clauses together. MGP Streaming services support the following keywords:

Keyword	Description	Example
AND	The search results will match all clauses in the query.	(acquisitionDate >2023-12-07) AND BBOX(featureGeometry,39.906477,-105.010843,39.918031,-104.99193)
OR	The search results will match at least one of the clauses in the query.	(productName='VIVID_STANDARD_30') OR (productName='VIVID_ADVANCED_15')
BETWEEN	The search results will fall between the values provided.	groundSampleDistance BETWEEN .15 AND .39
NOT	The search results will not contain the value listed in the clause or clauses.	NOT (productName='VIVID_STANDARD_30')
LIKE	Use with a % wildcard character in the value to filter for results that match part of a value.	productName LIKE 'VIVID%'

Response

Successful response code: 200 OK

The response is a map visualization.