API Reference

Get all supported sports

Returns a list of all valid sports supported by the API

EQULS API - Get Sports Endpoint

Overview

This endpoint retrieves a list of all valid sports supported by the EQULS API.

Details

  • URL: /v1/getSports
  • Method: GET
  • Authentication: Required (API Key)

Request Parameters

  • apiKey: A required query parameter. It must be a valid 24-character hexadecimal API key for authentication.

Response

  • Success (200 OK):

    • Returns a JSON object containing an array of supported sports.
    • Example:
      {
        "sports": ["football", "basketball", "baseball", ...]
      }
  • Error (401 Unauthorized):

    • Returned when the API key is missing or invalid.
    • Example:
      {
        "error": "Invalid API key",
        "details": [
          {
            "code": "invalid_string",
            "message": "Must be a valid ObjectID string",
            "path": ["apiKey"]
          }
        ]
      }

Notes

  • The API key must be a valid 24-character hexadecimal string in the MongoDB ObjectID format.
  • This endpoint is used to retrieve the list of sports that can be used with other endpoints.
  • The sports list is maintained in the configuration and may be updated as new sports are added to the platform.
Language
Click Try It! to start a request and see the response here!