openapi: 3.1.0
info:
  title: Maxar Geospatial Platform (Vantor Hub) Authentication Ordering API
  version: '1'
  description: 'REST API surface for the Maxar Geospatial Platform, branded in 2026 as

    Vantor Hub. This specification covers the Authentication / Token Service

    used to obtain OAuth2 bearer tokens and API keys, the Discovery API for

    STAC-style search of the Maxar catalog, and the Ordering API for

    estimating, validating, placing, and tracking orders for imagery and

    derived products. Bearer tokens are required for Admin and API Key

    operations; data-related endpoints accept either an OAuth2 bearer token

    or an API key.

    '
  contact:
    name: Vantor Hub Developer Portal
    url: https://developers.maxar.com/
servers:
- url: https://api.maxar.com
  description: Maxar / Vantor Hub production API
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: Ordering
paths:
  /ordering/list-pipelines:
    get:
      tags:
      - Ordering
      summary: List or get content pipelines
      parameters:
      - in: query
        name: pipeline_id
        schema:
          type: string
      responses:
        '200':
          description: Pipelines
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Pipeline'
  /ordering/estimate-usage:
    post:
      tags:
      - Ordering
      summary: Estimate usage for an order
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRequest'
      responses:
        '200':
          description: Usage estimate
  /ordering/validate-order:
    post:
      tags:
      - Ordering
      summary: Validate an order before placing it
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRequest'
      responses:
        '200':
          description: Validation result
  /ordering/place-order:
    post:
      tags:
      - Ordering
      summary: Place an order
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRequest'
      responses:
        '201':
          description: Order placed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
  /ordering/order-details:
    get:
      tags:
      - Ordering
      summary: Get details and status for an order
      parameters:
      - in: query
        name: order_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Order details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
  /ordering/order-events:
    get:
      tags:
      - Ordering
      summary: List status events for an order
      parameters:
      - in: query
        name: order_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Events
    post:
      tags:
      - Ordering
      summary: Cancel an order
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                order_id:
                  type: string
                action:
                  type: string
                  enum:
                  - cancel
      responses:
        '200':
          description: Cancellation accepted
components:
  schemas:
    OrderRequest:
      type: object
      properties:
        pipeline_id:
          type: string
        item_ids:
          type: array
          items:
            type: string
        delivery:
          type: object
        notification:
          type: object
    Order:
      type: object
      properties:
        order_id:
          type: string
        pipeline_id:
          type: string
        status:
          type: string
        created_at:
          type: string
          format: date-time
        delivery:
          type: object
        items:
          type: array
          items:
            type: object
    Pipeline:
      type: object
      properties:
        pipeline_id:
          type: string
        name:
          type: string
        description:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token obtained from the Authentication Token Service.
    apiKeyAuth:
      type: apiKey
      in: header
      name: MAXAR-API-KEY
      description: 'API key for data-related APIs. Cannot be used for Admin or API Key

        management endpoints, which require an OAuth2 bearer token.

        '