openapi: 3.1.0
info:
  title: Nearmap API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 8 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Nearmap has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 8
    pages-with-code: 0
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.nearmap.com/reference/tiles
  - https://developer.nearmap.com/reference/coverage
  - https://developer.nearmap.com/reference/tiles.md
  - https://developer.nearmap.com/reference/coverage.md
servers:
- url: https://api.nearmap.com
paths:
  /coverage/v2/aoi:
    post:
      operationId: post_coverage_v2_aoi
      tags:
      - Coverage
      summary: Equivalent to the polygon endpoint, but accepts the geometry in the request body.
      x-source: https://developer.nearmap.com/reference/coverage
      parameters:
      - name: apikey
        in: query
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of surveys to return. Defaults to 20.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
        description: Zero-based index of the first survey to return.
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: Return only surveys captured on or after this date (YYYY‑MM‑DD).
      - name: until
        in: query
        required: false
        schema:
          type: string
        description: Return only surveys captured on or before this date (YYYY‑MM‑DD).
      - name: include
        in: query
        required: false
        schema:
          type: string
        description: Only include surveys that match this tag type or type:name pair.
      - name: exclude
        in: query
        required: false
        schema:
          type: string
        description: Exclude surveys that match this tag type or type:name pair.
      - name: fields
        in: query
        required: false
        schema:
          type: string
        description: Comma‑separated list of response fields to include.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCoverageV2AoiRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCoverageV2AoiResponse'
      x-evidence:
        kind: documentation
  /coverage/v2/coord/{z}/{x}/{y}:
    get:
      operationId: get_coverage_v2_coord_z_x_y
      tags:
      - Coverage
      summary: Returns surveys for a Web Mercator tile coordinate (z/x/y).
      x-source: https://developer.nearmap.com/reference/coverage
      parameters:
      - name: z
        in: path
        required: true
        schema:
          type: string
      - name: x
        in: path
        required: true
        schema:
          type: string
      - name: y
        in: path
        required: true
        schema:
          type: string
      - name: apikey
        in: query
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: offset
        in: query
        required: false
        schema:
          type: integer
      - name: since
        in: query
        required: false
        schema:
          type: string
      - name: until
        in: query
        required: false
        schema:
          type: string
      - name: include
        in: query
        required: false
        schema:
          type: string
      - name: exclude
        in: query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCoverageV2CoordZXYResponse'
      x-evidence:
        kind: documentation
  /coverage/v2/point/{coord}:
    get:
      operationId: get_coverage_v2_point_coord
      tags:
      - Coverage
      summary: Returns surveys available at a longitude/latitude coordinate.
      x-source: https://developer.nearmap.com/reference/coverage
      parameters:
      - name: coord
        in: path
        required: true
        schema:
          type: string
      - name: apikey
        in: query
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: offset
        in: query
        required: false
        schema:
          type: integer
      - name: since
        in: query
        required: false
        schema:
          type: string
      - name: until
        in: query
        required: false
        schema:
          type: string
      - name: include
        in: query
        required: false
        schema:
          type: string
      - name: exclude
        in: query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCoverageV2PointCoordResponse'
      x-evidence:
        kind: documentation
  /coverage/v2/poly/{polygon}:
    get:
      operationId: get_coverage_v2_poly_polygon
      tags:
      - Coverage
      summary: Returns surveys that intersect a polygon area of interest.
      x-source: https://developer.nearmap.com/reference/coverage
      parameters:
      - name: polygon
        in: path
        required: true
        schema:
          type: string
      - name: apikey
        in: query
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: offset
        in: query
        required: false
        schema:
          type: integer
      - name: since
        in: query
        required: false
        schema:
          type: string
      - name: until
        in: query
        required: false
        schema:
          type: string
      - name: include
        in: query
        required: false
        schema:
          type: string
      - name: exclude
        in: query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCoverageV2PolyPolygonResponse'
      x-evidence:
        kind: documentation
  /coverage/v2/{v2id}/boundaries.geojson:
    get:
      operationId: get_coverage_v2_v2id_boundaries_geojson
      tags:
      - Coverage
      summary: Visualize total Nearmap coverage on a map.
      x-source: https://developer.nearmap.com/reference/coverage.md
      parameters:
      - name: v2id
        in: path
        required: true
        schema:
          type: string
      - name: apikey
        in: query
        required: true
        schema:
          type: string
        description: Your Nearmap API key.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCoverageV2V2IdBoundariesGeojsonResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at v2Id
  /coverage/v2/{v2id}/boundaries.{fileFormat}:
    get:
      operationId: get_coverage_v2_v2id_boundaries_fileFormat
      tags:
      - Coverage
      summary: Visualize total Nearmap coverage on a map.
      x-source: https://developer.nearmap.com/reference/coverage
      parameters:
      - name: v2id
        in: path
        required: true
        schema:
          type: string
      - name: fileFormat
        in: path
        required: true
        schema:
          type: string
      - name: apikey
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCoverageV2V2IdBoundariesFileformatResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at v2Id
  /tiles/v3/surveys/{surveyid}/{contenttype}/{z}/{x}/{y}.{format}:
    get:
      operationId: get_tiles_v3_surveys_surveyid_contenttype_z_x_y_format
      tags:
      - Tiles
      summary: Retrieve tiles for a specific survey
      description: Returns imagery for a single, explicitly specified survey. Use this when you need to pin your application to a known capture
        date.
      x-source: https://developer.nearmap.com/reference/tiles
      parameters:
      - name: surveyid
        in: path
        required: true
        schema:
          type: string
      - name: contenttype
        in: path
        required: true
        schema:
          type: string
      - name: z
        in: path
        required: true
        schema:
          type: string
      - name: x
        in: path
        required: true
        schema:
          type: string
      - name: y
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: path
        required: true
        schema:
          type: string
      - name: apikey
        in: query
        required: true
        schema:
          type: string
        description: API key for authentication.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /tiles/v3/{contenttype}/{z}/{x}/{y}.{format}:
    get:
      operationId: get_tiles_v3_contenttype_z_x_y_format
      tags:
      - Tiles
      summary: Retrieve tiles for a location
      description: Returns the most recent available tile for a given tile coordinate, subject to any since / until date filters you apply.
      x-source: https://developer.nearmap.com/reference/tiles
      parameters:
      - name: contenttype
        in: path
        required: true
        schema:
          type: string
      - name: z
        in: path
        required: true
        schema:
          type: string
      - name: x
        in: path
        required: true
        schema:
          type: string
      - name: y
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: path
        required: true
        schema:
          type: string
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: YYYY-MM-DD or relative (e.g. 12M). Return imagery captured on or after this date.
      - name: until
        in: query
        required: false
        schema:
          type: string
        description: YYYY-MM-DD. Return imagery captured on or before this date.
      - name: include
        in: query
        required: false
        schema:
          type: string
        description: Only include surveys matching this tag type or type:name pair.
      - name: exclude
        in: query
        required: false
        schema:
          type: string
        description: Exclude surveys matching this tag type or type:name pair.
      - name: apikey
        in: query
        required: true
        schema:
          type: string
        description: API key for authentication.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostCoverageV2AoiRequest:
      type: object
      properties:
        geometry:
          type: object
          description: GeoJSON geometry representing the area of interest.
      required:
      - geometry
    PostCoverageV2AoiResponse:
      type: object
      properties:
        surveys:
          type: array
          description: Array of survey metadata objects.
        limit:
          type: integer
          description: The limit applied to this response.
        offset:
          type: integer
          description: The offset applied to this response.
        total:
          type: integer
          description: Total number of surveys available for the query.
    GetCoverageV2CoordZXYResponse:
      type: object
      properties:
        surveys:
          type: array
        limit:
          type: integer
        offset:
          type: integer
        total:
          type: integer
    GetCoverageV2PointCoordResponse:
      type: object
      properties:
        surveys:
          type: array
          description: Array of survey metadata objects.
        limit:
          type: integer
        offset:
          type: integer
        total:
          type: integer
    GetCoverageV2PolyPolygonResponse:
      type: object
      properties:
        surveys:
          type: array
        limit:
          type: integer
        offset:
          type: integer
        total:
          type: integer
    GetCoverageV2V2IdBoundariesGeojsonResponse:
      type: object
      properties:
        features:
          type: array
          description: GeoJSON features representing aggregated coverage boundaries.
    GetCoverageV2V2IdBoundariesFileformatResponse:
      type: object
      properties:
        type:
          type: string
          description: FeatureCollection
        features:
          type: array
          description: Aggregated coverage boundary features.
  securitySchemes:
    apikey:
      type: apiKey
      in: query
      name: Authorization
      x-source: https://developer.nearmap.com/docs/authentication.md
tags:
- name: Coverage
- name: Tiles
security:
- apikey: []