5DollarFootballAPI Bookmakers API

openapi: 3.2.0
info:
  title: 5DollarFootballAPI — Football Data Bookmakers API
  version: 1.0.0
  summary: 'Football (soccer) data: live scores, fixtures, standings, corner and card statistics, and odds.'
  description: The 5DollarFootballAPI is a read-only REST API.
  termsOfService: https://5dollarfootballapi.com/terms
  contact:
    name: 5DollarFootballAPI support
    url: https://5dollarfootballapi.com/contact
    email: contact@5dollarfootballapi.com
servers:
- url: https://api.5dollarfootballapi.com/v1
  description: Production
security:
- bearerAuth: []
- apiKeyHeader: []
tags:
- name: bookmakers
  description: The bookmakers quoted by the odds endpoints.
paths:
  /bookmakers:
    get:
      operationId: bookmakers
      summary: List bookmakers
      description: The bookmakers accepted by ?bookmakers= on /v1/fixtures/{id}/odds, in display order. Bet365 carries all ten markets and comes with every paid plan; the rest require Ultra — the coverage table on the docs index shows what each carries.
      tags:
      - bookmakers
      parameters: []
      responses:
        '200':
          description: Success
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Unix timestamp when the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessEnvelope'
              example:
                success: 1
                data:
                - id: 281
                  name: Bet 365
                  slug: bet365
                - id: 177
                  name: Pinnacle
                  slug: pinnacle
                - id: 115
                  name: William Hill
                  slug: williamhill
                - id: 82
                  name: Ladbrokes
                  slug: ladbrokes
                - id: 1047
                  name: 1xBet
                  slug: 1xbet
        '400':
          description: Invalid parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: The resource is outside your plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      externalDocs:
        description: Endpoint reference
        url: https://5dollarfootballapi.com/docs/bookmakers
components:
  schemas:
    ErrorEnvelope:
      type: object
      description: Every error response. The status code and `error.code` identify the failure; `message` is for humans.
      required:
      - success
      - error
      properties:
        success:
          type: integer
          const: 0
        error:
          type: object
          required:
          - type
          - code
          - message
          properties:
            type:
              type: string
              description: Error family, e.g. authentication_error.
            code:
              type: string
              description: Machine-readable code, e.g. missing_api_key.
            message:
              type: string
            param:
              type:
              - string
              - 'null'
              description: The parameter at fault, when one applies.
            doc_url:
              type: string
            request_id:
              type: string
              description: Quote this in support requests.
    Pagination:
      type: object
      description: Returned by list endpoints. Keep requesting pages while `has_more` is true.
      properties:
        page:
          type: integer
        per_page:
          type: integer
        count:
          type: integer
          description: Rows on this page.
        has_more:
          type: boolean
    SuccessEnvelope:
      type: object
      description: Every successful response. `data` is the endpoint payload — see the example on each operation. List endpoints add `pagination`.
      required:
      - success
      - data
      properties:
        success:
          type: integer
          const: 1
        data:
          description: 'Endpoint payload: an object, or an array of objects on list endpoints.'
          oneOf:
          - type: object
          - type: array
            items:
              type: object
        pagination:
          $ref: '#/components/schemas/Pagination'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your key as `Authorization: Bearer <key>`.'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative to the Authorization header.
externalDocs:
  description: Full documentation
  url: https://5dollarfootballapi.com/docs