Hivemapper Account API

openapi: 3.2.0
info:
  title: Hivemapper Account API
  x-refined-note:
  - x-generated differs across the merged source definitions and was not carried
  - x-method differs across the merged source definitions and was not carried
  - x-source differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged account across 2 of this provider''s published API definitions: hivemapper-openapi.json, hivemapper-beemaps-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://beemaps.com/api/developer
  description: Production
- url: https://hivemapper.com/api/developer
  description: Legacy Hivemapper Developer API host
tags:
- name: Account
  description: Account balance and usage
paths:
  /balance:
    get:
      tags:
      - Account
      summary: Check API credit balance
      responses:
        '200':
          description: Current balance
          content:
            application/json:
              schema:
                type: object
                properties:
                  balance:
                    type: number
                    example: 4250.5
                  currency:
                    type: string
                    example: USD
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
      - ApiKeyQuery: []
      operationId: getBalance
      x-operation-id-source: derived
    servers:
    - url: https://beemaps.com/api/developer
      description: Production
  /history:
    get:
      tags:
      - Account
      summary: Query API usage history
      responses:
        '200':
          description: Usage history
          content:
            application/json:
              schema:
                type: object
                properties:
                  history:
                    type: array
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          format: date
                        endpoint:
                          type: string
                        requests:
                          type: integer
                        credits:
                          type: number
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
      - ApiKeyQuery: []
      operationId: getHistory
      x-operation-id-source: derived
    servers:
    - url: https://beemaps.com/api/developer
      description: Production
  /devices:
    get:
      operationId: getDevices
      summary: Get camera calibration parameters
      description: 'Get camera intrinsic parameters (focal length, distortion coefficients) for supported device types: hdc (Hivemapper Dashcam), hdcs (Dashcam S), and bee. This endpoint does not require authentication.'
      tags:
      - Account
      security: []
      responses:
        '200':
          description: Camera calibration parameters by device type.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://beemaps.com/api/developer
      description: Bee Maps Developer API (current)
    - url: https://hivemapper.com/api/developer
      description: Legacy Hivemapper Developer API host
components:
  responses:
    Forbidden:
      description: Forbidden — missing or invalid API key
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
        statusCode:
          type: integer
    HistoryEntry:
      type: object
      properties:
        area:
          type: number
          description: Queried area in square km.
        payload:
          type: object
          additionalProperties: true
          description: Query geometry.
        timestamp:
          type: string
          format: date-time
        weeks:
          type: array
          items:
            type: string
        credits:
          type: number
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: 'API key passed as Basic auth header: `Authorization: Basic <API_KEY>`'
    ApiKeyQuery:
      type: apiKey
      in: query
      name: apiKey
      description: API key passed as query parameter (used for burst endpoints)
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic authentication. Send Authorization: Basic <base64(username:api-key)>.'
    apiKeyQuery:
      type: apiKey
      in: query
      name: apiKey
      description: API key passed as the apiKey query parameter.
externalDocs:
  description: Full documentation
  url: https://docs.beemaps.com
x-refined-from:
- hivemapper-openapi.json
- hivemapper-beemaps-openapi.yml
x-provenance:
  method: harvested
  publisher: Hivemapper
  source: https://beemaps.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)