find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/realtimesportsapi-com:realtimesportsapi-com-webhooks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Realtimesportsapi Com Webhooks API
  version: 1.0.0
  contact:
    name: Realtime Sports API support
    email: austin@elcodev.com
    url: https://www.realtimesportsapi.com/?utm_source=openapi
  license:
    name: Proprietary
    url: https://www.realtimesportsapi.com/terms?utm_source=openapi
  termsOfService: https://www.realtimesportsapi.com/terms?utm_source=openapi
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: original.json, realtimesportsapi-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.realtimesportsapi.com/api/v1
  description: Production
security:
- BearerAuth: []
- ApiKeyHeader: []
tags:
- name: Webhooks
  description: Manage webhook subscriptions (paid plans). These management calls do not count toward your quota; deliveries do.
paths:
  /webhooks:
    get:
      operationId: listWebhooks
      tags:
      - Webhooks
      summary: List your webhooks
      description: Requires a paid plan.
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Webhook'
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                      count:
                        type: integer
                required:
                - success
                - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Paid plan or direct API key required (TIER_REQUIRED, DIRECT_API_KEY_REQUIRED).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createWebhook
      tags:
      - Webhooks
      summary: Create a webhook
      description: Deliveries are signed with HMAC-SHA256 in the `X-Webhook-Signature` header. The signing secret is returned only in this response (retrieve it later via /webhooks/{webhookId}/secret).
      parameters: []
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    allOf:
                    - $ref: '#/components/schemas/Webhook'
                    - type: object
                      properties:
                        secret:
                          type: string
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                required:
                - success
                - data
        '400':
          description: Invalid body (INVALID_JSON, INVALID_URL, INVALID_EVENTS, INVALID_LEAGUES, INVALID_FREQUENCY).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Paid plan or direct API key required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/WebhookInput'
              required:
              - url
              - events
    servers:
    - url: https://www.realtimesportsapi.com/api/v1
      description: Production
  /webhooks/{webhookId}:
    get:
      operationId: getWebhook
      tags:
      - Webhooks
      summary: Get a webhook
      parameters:
      - name: webhookId
        in: path
        required: true
        description: Webhook id, as returned by GET /webhooks.
        schema:
          type: string
          example: 3fK9xQ2mLp7Rz1Vb
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/Webhook'
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                required:
                - success
                - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Not your webhook, or paid plan required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook not found (WEBHOOK_NOT_FOUND).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateWebhook
      tags:
      - Webhooks
      summary: Update a webhook
      description: 'Partial update of any of url, events, leagues, frequency, active. `active: true` re-enables an automatically deactivated webhook.'
      parameters:
      - name: webhookId
        in: path
        required: true
        description: Webhook id, as returned by GET /webhooks.
        schema:
          type: string
          example: 3fK9xQ2mLp7Rz1Vb
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/Webhook'
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                required:
                - success
                - data
        '400':
          description: Invalid body or no changes (NO_CHANGES).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Not your webhook, or paid plan required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookInput'
    delete:
      operationId: deleteWebhook
      tags:
      - Webhooks
      summary: Delete a webhook
      parameters:
      - name: webhookId
        in: path
        required: true
        description: Webhook id, as returned by GET /webhooks.
        schema:
          type: string
          example: 3fK9xQ2mLp7Rz1Vb
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      deleted:
                        type: boolean
                        example: true
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                required:
                - success
                - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Not your webhook, or paid plan required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://www.realtimesportsapi.com/api/v1
      description: Production
  /webhooks/{webhookId}/secret:
    get:
      operationId: getWebhookSecret
      tags:
      - Webhooks
      summary: Reveal the signing secret
      parameters:
      - name: webhookId
        in: path
        required: true
        description: Webhook id, as returned by GET /webhooks.
        schema:
          type: string
          example: 3fK9xQ2mLp7Rz1Vb
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      secret:
                        type: string
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                required:
                - success
                - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Not your webhook, or paid plan required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: rotateWebhookSecret
      tags:
      - Webhooks
      summary: Rotate the signing secret
      description: The old secret stops being used within about one second.
      parameters:
      - name: webhookId
        in: path
        required: true
        description: Webhook id, as returned by GET /webhooks.
        schema:
          type: string
          example: 3fK9xQ2mLp7Rz1Vb
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      secret:
                        type: string
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                required:
                - success
                - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Not your webhook, or paid plan required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://www.realtimesportsapi.com/api/v1
      description: Production
  /webhooks/{webhookId}/test:
    post:
      operationId: testWebhook
      tags:
      - Webhooks
      summary: Send a test delivery
      description: 'Sends a signed sample payload (header `X-Webhook-Test: true`), or replays a recorded failed delivery when `deliveryId` is given.'
      parameters:
      - name: webhookId
        in: path
        required: true
        description: Webhook id, as returned by GET /webhooks.
        schema:
          type: string
          example: 3fK9xQ2mLp7Rz1Vb
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      delivered:
                        type: boolean
                      statusCode:
                        type:
                        - integer
                        - 'null'
                      error:
                        type:
                        - string
                        - 'null'
                      durationMs:
                        type: integer
                      responseSnippet:
                        type:
                        - string
                        - 'null'
                      sent:
                        type: object
                        properties:
                          url:
                            type: string
                          event:
                            type: string
                          headers:
                            type: object
                            additionalProperties:
                              type: string
                          body:
                            type: object
                            additionalProperties: true
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                required:
                - success
                - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Not your webhook, or paid plan required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook or delivery not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                eventType:
                  $ref: '#/components/schemas/WebhookEventType'
                deliveryId:
                  type: string
                  description: Replay this failed delivery instead of a sample.
    servers:
    - url: https://www.realtimesportsapi.com/api/v1
      description: Production
  /webhooks/{webhookId}/deliveries:
    get:
      operationId: listWebhookDeliveries
      tags:
      - Webhooks
      summary: List failed deliveries
      description: Recent failed delivery attempts. Successful deliveries are not recorded individually.
      parameters:
      - name: webhookId
        in: path
        required: true
        description: Webhook id, as returned by GET /webhooks.
        schema:
          type: string
          example: 3fK9xQ2mLp7Rz1Vb
      - name: limit
        in: query
        required: false
        description: Maximum deliveries to return (default 50, max 200).
        schema:
          type: integer
          example: 50
          default: 50
          minimum: 1
          maximum: 200
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookDelivery'
                  meta:
                    type: object
                    properties:
                      rateLimit:
                        $ref: '#/components/schemas/RateLimit'
                      count:
                        type: integer
                      note:
                        type: string
                required:
                - success
                - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Not your webhook, or paid plan required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://www.realtimesportsapi.com/api/v1
      description: Production
components:
  schemas:
    WebhookEventType:
      type: string
      example: event.score_change
      enum:
      - event.live
      - event.score_change
      - event.status_change
      - event.play
      - event.final
      - event.play_corrected
      description: 'event.play_corrected (opt-in) is sent when the provider revises a play we already sent: same payload as event.play with corrected: true and the original play id, delivered immediately. Replace the stored play with that id.'
    WebhookDelivery:
      type: object
      properties:
        id:
          type: string
        eventType:
          type: string
        status:
          type: string
          example: failed
        attempts:
          type: integer
          example: 1
        responseCode:
          type:
          - integer
          - 'null'
          example: 500
        error:
          type:
          - string
          - 'null'
        eventId:
          type:
          - string
          - 'null'
        league:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: MISSING_TOKEN
            message:
              type: string
              example: Authorization required
            hint:
              type: string
              example: 'Use Authorization: Bearer <your-api-key> or X-API-Key: <your-api-key>.'
          required:
          - code
          - message
      required:
      - success
      - error
    WebhookFrequency:
      type: string
      example: asap
      enum:
      - asap
      - 30s
      - 1m
      - 5m
      - 10m
      - 30m
      description: 'Delivery frequency (same rules on WebSocket subscriptions). ''asap'' (default) delivers everything immediately. Any other value conflates only repeating updates per game: event.status_change where status.state is unchanged (clock/period/detail) and event.odds_change are held and the latest one per game is delivered at the next fixed tick (at most one per game per window). event.play, event.score_change, event.live, event.final and status changes where status.state changes (e.g. pre to in, in to post, Postponed) are always delivered immediately; a state change discards that game''s held update. Each delivery counts once toward usage.'
    Webhook:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
          example: https://example.com/hooks/sports
          format: uri
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
        leagues:
          type:
          - array
          - 'null'
          items:
            type: string
            example: nfl
          description: League slugs to filter on; null = all leagues.
        frequency:
          $ref: '#/components/schemas/WebhookFrequency'
        active:
          type: boolean
          example: true
        consecutiveFailures:
          type: integer
          example: 0
        deactivatedReason:
          type:
          - string
          - 'null'
        deactivatedAt:
          type:
          - string
          - 'null'
          format: date-time
        createdAt:
          type: string
        updatedAt:
          type: string
    RateLimit:
      type: object
      properties:
        limit:
          type: integer
          example: 10000
          description: Calls included this month.
        remaining:
          type: integer
          example: 9876
          description: Calls remaining this month (approximate; updated asynchronously).
        reset:
          type: integer
          example: 1767225600000
          description: Quota reset time, Unix epoch milliseconds.
    WebhookInput:
      type: object
      properties:
        url:
          type: string
          example: https://example.com/hooks/sports
          format: uri
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
        leagues:
          type:
          - array
          - 'null'
          items:
            type: string
            example: nfl
        frequency:
          $ref: '#/components/schemas/WebhookFrequency'
        active:
          type: boolean
          example: true
  responses:
    RateLimitExceeded:
      description: 'Too many requests: either the monthly quota is exhausted (code RATE_LIMIT_EXCEEDED; upgrade or enable overage) or the plan''s per-second rate was exceeded (code RATE_LIMIT_PER_SECOND; Free 1/s, Starter 5/s, Growth 10/s, Pro 20/s, Scale 100/s). Wait for `Retry-After` seconds.'
      headers:
        Retry-After:
          description: Seconds until you may retry.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: 'Missing, malformed, unknown or expired API key (codes: MISSING_TOKEN, USER_NOT_FOUND, TRIAL_EXPIRED).'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Unexpected error. Safe to retry with backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key from the dashboard: `Authorization: Bearer <api key>`. Keys are opaque strings, not JWTs.'
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative to the Authorization header (useful behind proxies that strip Authorization).
externalDocs:
  description: Guides, WebSocket and webhook docs
  url: https://www.realtimesportsapi.com/docs?utm_source=openapi
x-refined-from:
- original.json
- realtimesportsapi-com-openapi.json