> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apexiumbet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the health of the Trading API

> No API key needed. 200 while healthy or degraded, 503 when unhealthy or when the API is switched off. Refreshed at most every 15 seconds.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/health
openapi: 3.1.0
info:
  title: Apexium Trading API
  version: '1'
  description: Public API, authenticated with an API key in the x-api-key header.
servers:
  - url: https://api.apexiumbet.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Health
    description: Whether the API is up, without an API key
  - name: Account
    description: The account behind the API key and its balance
  - name: Reference data
    description: OddsPapi sports, tournaments, participants, markets and bookmakers
  - name: Fixtures
    description: 'OddsPapi fixtures: schedule, status, scores'
  - name: Odds
    description: OddsPapi odds, limited to the account's bookmakers
  - name: Betslip
    description: >-
      The price and stake limits of one selection at each of the account's
      bookmakers
  - name: Orders
    description: Preview, place, read and cancel orders
  - name: Bets
    description: The bets your orders were split into
  - name: Positions and PnL
    description: Open exposure and realised results
paths:
  /v1/health:
    get:
      tags:
        - Health
      summary: Get the health of the Trading API
      description: >-
        No API key needed. 200 while healthy or degraded, 503 when unhealthy or
        when the API is switched off. Refreshed at most every 15 seconds.
      responses:
        '200':
          description: >-
            `status` is the worst of the services. A degraded API still places
            orders.
          content:
            application/json:
              schema:
                description: >-
                  `status` is the worst of the services. A degraded API still
                  places orders.
                type: object
                required:
                  - status
                  - time
                  - services
                properties:
                  status:
                    type: string
                    enum:
                      - healthy
                      - degraded
                      - unhealthy
                  time:
                    format: date-time
                    type: string
                  services:
                    type: object
                    required:
                      - database
                      - caching
                      - betPlacement
                      - betUpdates
                    properties:
                      database:
                        type: string
                        enum:
                          - healthy
                          - degraded
                          - unhealthy
                      caching:
                        type: string
                        enum:
                          - healthy
                          - degraded
                          - unhealthy
                      betPlacement:
                        type: string
                        enum:
                          - healthy
                          - degraded
                          - unhealthy
                      betUpdates:
                        type: string
                        enum:
                          - healthy
                          - degraded
                          - unhealthy
        '429':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                  - description: >-
                      `status` is the worst of the services. A degraded API
                      still places orders.
                    type: object
                    required:
                      - status
                      - time
                      - services
                    properties:
                      status:
                        type: string
                        enum:
                          - healthy
                          - degraded
                          - unhealthy
                      time:
                        format: date-time
                        type: string
                      services:
                        type: object
                        required:
                          - database
                          - caching
                          - betPlacement
                          - betUpdates
                        properties:
                          database:
                            type: string
                            enum:
                              - healthy
                              - degraded
                              - unhealthy
                          caching:
                            type: string
                            enum:
                              - healthy
                              - degraded
                              - unhealthy
                          betPlacement:
                            type: string
                            enum:
                              - healthy
                              - degraded
                              - unhealthy
                          betUpdates:
                            type: string
                            enum:
                              - healthy
                              - degraded
                              - unhealthy
                  - description: >-
                      Error. `code` is stable; `message` is for humans and may
                      change.
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        enum:
                          - VALIDATION_FAILED
                          - MODE_REQUIRED
                          - INVALID_STAKE
                          - INVALID_PRICE
                          - INVALID_EXPIRY
                          - CURRENCY_NOT_SUPPORTED
                          - BOOKMAKER_NOT_AVAILABLE_VIA_API
                          - BOOKMAKER_NOT_AVAILABLE
                          - INVALID_API_KEY
                          - API_ACCESS_DENIED
                          - ACCOUNT_NOT_ACTIVE
                          - BETTING_NOT_ALLOWED
                          - BALANCE_UNAVAILABLE
                          - INSUFFICIENT_FUNDS
                          - MAX_STAKE_PER_FIXTURE_EXCEEDED
                          - PRICE_NOT_AVAILABLE
                          - PRICE_CHANGED
                          - NO_LIQUIDITY
                          - INSUFFICIENT_LIQUIDITY
                          - CLIENT_ORDER_ID_REUSED
                          - PREVIOUS_ATTEMPT_UNRESOLVED
                          - NOT_FOUND
                          - INVALID_CURSOR
                          - INVALID_WINDOW
                          - ORDER_BUSY
                          - CONFLICT
                          - FORBIDDEN
                          - RATE_LIMITED
                          - BETTING_SUSPENDED
                          - EXPIRY_NOT_AVAILABLE
                          - PUBLIC_API_DISABLED
                          - SERVICE_UNAVAILABLE
                          - UPSTREAM_UNAVAILABLE
                          - FEED_UNAVAILABLE
                          - FEED_TIMEOUT
                          - INTERNAL_ERROR
                      message:
                        type: string
                      details: {}
      security: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.