Skip to main content

Worldview 3D (Limited Release)

Ordering and downloading Worldview 3D data is in limited release and is not currently available to all accounts.

Overview​

Worldview 3D is an on-demand suite of three-dimensional surface mesh, elevation, and true ortho products that can be generated from stereo image pairs collected on specific dates. Worldview 3D leverages photogrammetric stereo collections that are correlated and enhanced by the global Vivid Terrain 3D Surface Model.

Note: currently supported sensors are WV01, WV02, WV03.

Ordering Worldview 3D Products​

This documentation describes the requirements that are specific for ordering Worldview 3D products. To see the full description of an order request, see the Ordering API Guide.

When you place an order for data, you will:

  • include the name and the namespace in the URL path.
  • include the settings object for the pipeline in the order request body.
ProductNamespaceName
Worldview 3D3drapid

Supported Requests​

The table below lists all requests available for Worldview 3D.

Base URL: https://api.maxar.com

Request TypeMethodPathDescription
Place an OrderPOSTordering/v1/pipelines/3d/rapid/orderPlace an order for Worldview 3D products.
Validate OrderPOSTordering/v1/pipelines/3d/rapid/validateVerify that the order passes validation checks before submission.
Estimate UsagePOSTordering/v1/pipelines/rapid/3d/estimateGet a usage estimate for an order request before placing the order.
Get Order DetailsGETordering/v1/orders/{orderID}Get the details and status of an order request.
Cancel OrderPOSTordering/v1/orders/{orderid}/cancelCancels the order specified in the URL path. Orders cannot be canceled once the delivery process has started.

Place an order​

POST https://api.maxar.com/ordering/v1/pipelines/3D/rapid/order

The following Worldview 3D products are available to order:

  • Worldview 3D 3D Surface Model (3DSM)
  • Worldview 3D Digital Surface Model (DSM)
  • Worldview 3D Bundle (3DSM, DSM, and True Ortho)

The request body for an order includes a settings object. The fields in this object are specific to ordering Worldview 3D.

ParameterRequiredDescriptionAllowed ValuesExample
catalog_idsrequiredArray of Catalog IDs for each image of the stereo-pair chosen for the Worldview 3D productionTwo IDs“catalog_ids”: [“1030010108287D00”, “103001010885E900”]
aoirequiredAOI to processGeoJSON polygon with no holes (10-10,000 sqkm)see example
product_namerequiredName of the product or bundle to be ordered3dsm, dsm, bundle“product_name”: [“3dsm”]

Note: AOIs must be a minimum of 10 sqkm and a maximum of 10,000 sqkm.

Example Worldview 3D settings object
  "settings": {
    "catalog_ids": ["1030010108287D00", "103001010885E900"],
    "aoi": {
      "type": "Feature",
      "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -76.90581392377592,
                39.02739413964315
              ],
              [
                -76.90581392377592,
                38.98574058127778
              ],
              [
                -76.83012627216489,
                38.98574058127778
              ],
              [
                -76.83012627216489,
                39.02739413964315
              ],
              [
                -76.90581392377592,
                39.02739413964315
              ]
            ]
          ]
    }},
    "product_name": "3dsm",
    "infill_stereo_shadows":false
  }

Worldview 3D Elevation Products​

Worldview 3D 3D Surface Model (3DSM)​

  • Product name to order: 3dsm

Worldview 3D 3DSM orders come with the following default parameters and values:

  • Post spacing: 0.5 m
  • File Format: Cesium 3D Tiles 1.1
  • Reference System: WGS84 G1762
  • Coordinate System: Geocentric (ECEF)

Optional ordering parameters for Worldview 3D 3DSM:

ParameterDefault ValueOptional ValueExample
infill_stereo_shadowstruefalse“infill_stereo_shadows”:false

Worldview 3D Digital Surface Model (DSM)​

  • Product name to order: dsm

Worldview 3D DSM orders come with the following default parameters and values:

  • Post spacing: 0.5 m
  • File Format: GeoTIFF, deflate compressed
  • Reference System: WGS84 G1674
  • Coordinate System: UTM

Optional ordering parameters for Worldview 3D DSM:

ParameterDefault ValueOptional ValueExample
infill_stereo_shadowstruefalse“infill_stereo_shadows”:false
vertical_systemELLIPSOIDEGM96, EGM2008“vertical_system”: “EGM2008”

Worldview 3D Bundle (3DSM, DSM, True Ortho)​

  • Product name to order: bundle

The Worldview 3D Bundle content type allows you to order 3D Surface Models, Digital Surface Models and True Orthos in a single order. Your selection of the infill option will apply to each component of the bundle. All other order settings are defaulted as outlined below.

Worldview 3D 3DSM​
  • File Format: Cesium 3D Tiles 1.1
  • Reference System: WGS84 G1762
  • Coordinate System: Geocentric (ECEF)
Worldview 3D DSM​
  • File Format: GeoTIFF, deflate compressed
  • Reference System: WGS84 G1674
  • Coordinate System: UTM
  • Vertical System: Ellipsoid
Worldview 3D True Ortho​
  • File Format: GeoTIFF, deflate compressed
  • Reference System: WGS84 G1674
  • Coordinate System: UTM

Optional ordering parameters for Worldview 3D Bundle:

ParameterDefault ValueOptional ValueExample
infill_stereo_shadowstruefalse“infill_stereo_shadows”:false
Example Worldview 3D order request
{
  "settings": {
    "catalog_ids": ["1030010108287D00", "103001010885E900"],
    "aoi": {
      "type": "Feature",
      "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -76.90581392377592,
                39.02739413964315
              ],
              [
                -76.90581392377592,
                38.98574058127778
              ],
              [
                -76.83012627216489,
                38.98574058127778
              ],
              [
                -76.83012627216489,
                39.02739413964315
              ],
              [
                -76.90581392377592,
                39.02739413964315
              ]
            ]
          ]
    }},
    "product_name": "3dsm",
    "infill_stereo_shadows":false
    },
    "output_configs": [
        {
            "type": "download",
            "format": "zip"
        }
      ],
    "notifications": [
      {
        "type": "email",
        "target": "user@example.com",
        "level": "FINAL_ONLY"
      }
    ]
}
Example Worldview 3D order response
{
  "data": {
    "id": "<order ID>",
    "date_created": "2025-06-27T21:38:07Z",
    "date_modified": "2025-06-27T21:38:18Z",
    "creator_id": "<user ID>",
    "creator_group_id": "<group ID>",
    "pipeline_id": "3d/rapid",
    "output_configs": [
      {
        "type": "download",
        "format": "zip"
      }
    ],
    "notifications": [
      {
        "type": "email",
        "target": "user@example.com",
        "level": "FINAL_ONLY"
      }
    ],
    "metadata": {},
    "status": "RECEIVED",
    "status_details": {},
    "cancellation_requested": false,
    "process_details": {},
    "delivery_details": {},
    "order_links": {
      "self": "https://api.maxar.com/ordering/v1/orders/<order ID>",
      "events": "https://api.maxar.com/ordering/v1/orders/<order ID>/events"
    },
    "settings": {
      "catalog_ids": [
        "1030010108287D00",
        "103001010885E900"
      ],
      "aoi": {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -76.90581392377592,
                39.02739413964315
              ],
              [
                -76.90581392377592,
                38.98574058127778
              ],
              [
                -76.83012627216489,
                38.98574058127778
              ],
              [
                -76.83012627216489,
                39.02739413964315
              ],
              [
                -76.90581392377592,
                39.02739413964315
              ]
            ]
          ]
        }
      },
      "product_name": "3dsm",
      "infill_stereo_shadows":false
    }
  },
  "links": {
    "request": "https://api.maxar.com/ordering/v1/pipelines/3d/rapid/order"
  },
  "request_timestamp": "2025-06-27T21:38:04Z",
  "response_timestamp": "2025-06-27T21:38:19Z",
  "request_duration": 15

Validate an order request​

To validate your order before placing it, send your request body to the /validate endpoint first.

POST https://api.maxar.com/ordering/v1/pipelines/3D/rapid/validate

This will verify that your request is formatted correctly and contains the required settings and allowed values for those settings.

Validate order example 200 response

Status: 200 OK

{
  "data": {
    "message": "validation successful"
  },
  "links": {
    "request": "https://api.maxar.com/ordering/v1/pipelines/3d/rapid/validate"
  },
  "request_timestamp": "2025-04-14T20:26:44Z",
  "response_timestamp": "2025-04-14T20:26:48Z",
  "request_duration": 4
}
Validate order example 400 response

In this example, the order did not pass validation because a field name was incorrect.

Status: 400 Bad Request

{
  "links": {
    "request": "https://api.maxar.com/ordering/v1/pipelines/3d/rapid/validate"
  },
  "request_timestamp": "2025-04-14T20:29:32Z",
  "response_timestamp": "2025-04-14T20:29:40Z",
  "request_duration": 8,
  "error": {
    "error_code": "invalid_request_body",
    "error_type": "invalid_request_error",
    "error_messages": [
      "Invalid order settings: $: Additional properties are not allowed ('catalogIDs' was unexpected)",
      "Invalid order settings: $: 'catalog_ids' is a required property"
    ]
  }
}

Get a usage estimate​

The /estimate endpoint returns a usage estimate and a copy of the JSON request body.

POST https://api.maxar.com/ordering/v1/pipelines/3d/rapid/estimate
Estimate order example 200 response

Status: 200 OK

{
  "data": {
    "usage_estimate": [
      {
        "pipeline_id": "3d/rapid",
        "metrics": [
          {
            "units": "sqkm",
            "quantity": 30.316,
            "description": "We've streamlined the AOI as part of the process",
            "usage_details": {}
          }
        ],
        "product_id": 496,
        "date_reported": "2025-07-03T20:54:10Z"
      }
    ],
    "order_config": {
      "pipeline_id": "3d/rapid",
      "output_configs": [
        {
          "type": "download",
          "format": "zip"
        }
      ],
      "notifications": [
        {
          "type": "email",
          "target": "user@example.com",
          "level": "FINAL_ONLY"
        }
      ],
      "metadata": {},
      "settings": {
        "catalog_ids": [
          "1030010108287D00",
          "103001010885E900"
        ],
        "aoi": {
          "type": "Feature",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  -76.90581392377592,
                  39.02739413964315
                ],
                [
                  -76.90581392377592,
                  38.98574058127778
                ],
                [
                  -76.83012627216489,
                  38.98574058127778
                ],
                [
                  -76.83012627216489,
                  39.02739413964315
                ],
                [
                  -76.90581392377592,
                  39.02739413964315
                ]
              ]
            ]
          }
        },
        "product_name": "3dsm"
      }
    }
  },
  "links": {
    "request": "https://api.maxar.com/ordering/v1/pipelines/3d/rapid/estimate"
  },
  "request_timestamp": "2025-07-03T20:53:57Z",
  "response_timestamp": "2025-07-03T20:54:10Z",
  "request_duration": 13
}

Get order status​

Once an order is placed, you can monitor its status or review the details of your order by making the following request with your order ID.

POST 
https://api.maxar.com/ordering/v1/orders/:id

The id was returned in the response body to your order request. It can also be found in your notifications.

Cancel an order​

Once an order is placed, you can monitor its status or review the details of your order by making the following request with your order ID.

POST 
https://api.maxar.com/ordering/v1/orders/:id

The id was returned in the response body to your order request. It can also be found in your notifications.

Additional Information​

Finding stereo pair source images​

The Discovery catalog service holds STAC collections for stereo pairs. See Querying stereo pairs for more information. For sensor supported by Worldview 3D you will need to search the following collections:

  • wv01-intrack-stereo
  • wv02-intrack-stereo
  • wv03-vnir-intrack-stereo

The two catalog IDs for the images can be found in the item properties field named image_identifiers.

Stereo shadow infill​

When activated, areas that are hidden from view by terrain or surface features can be filled with elevation values from the Precision3D elevation model if available. Textures for these values are generated from either leg of the stereo image pair. If elevation values and/or image pixels are not available, values will be interpolated from the surroundings.

If stereo shadow infill is not used, areas where processing cannot be completed will be filled withe null values.

Content Declaration Mask​

All product types will include a Content Declaration Mask file in the deliverables. This file offers a per-pixel raster mask that signifies the validity of the Worldview 3D model. It distinguishes pixels containing valid stereo photogrammetric measurements derived from the stereo production, as well as those that have been altered or where Worldview 3D stereoscopic production could not be completed due to inadequate photogrammetric or reference data properties.

Content Declaration Mask format:

  • 8-bit GeoTIFF raster with a color palette.
  • Deflate lossless compression.
Palette ValueRGB colorName
255(120,176,45)Stereo reconstruction
192(19, 125, 192)Flattened
160(240,176,21)Stereo shadow – Precision3D geometry infill
144(240,20,180)Stereo shadow - Interpolation
128(25,25,25)Stereo shadow – Nodata
96(225, 225, 225)Cloud occlusion
64(255,70,0)No coverage
0(64,64,64)Nodata