menu Method — Sports Line Menu

Purpose

The menu method returns the hierarchy of the available sports line:

sport → country → tournament

Each level also includes the number of available matches. Use this method to build a website menu and obtain the identifiers required to request match lists.

The menu response does not contain matches or odds. Use the events method to retrieve them.

Request

GET https://YOUR_API_DOMAIN/v1/menu/{type}/{lang}

Send the API key in the HTTP header:

Package: YOUR_API_KEY

Path Parameters

Values of type:

Optional Query Parameters

Query parameters are added after ?. For example:

GET https://YOUR_API_DOMAIN/v1/menu/live/en?cybersport=true

The full responses stored with this documentation were retrieved without query parameters, which means cybersport=false.

Live Request Example

curl --request GET \
  --url 'https://YOUR_API_DOMAIN/v1/menu/live/en' \
  --header 'Package: YOUR_API_KEY'

For Prematch, replace live with line:

curl --request GET \
  --url 'https://YOUR_API_DOMAIN/v1/menu/line/en' \
  --header 'Package: YOUR_API_KEY'

Shortened Live Response Example

The following is an excerpt from a real English response. The values are unchanged, but the arrays have been shortened to one sport, one country, and one tournament.

{
  "status": 1,
  "page": "/v1/menu",
  "body": [
    {
      "id": 1,
      "name": "Football",
      "counter": 56,
      "sub": [
        {
          "id": 208,
          "name": "Sri Lanka",
          "counter": 1,
          "sport_id": 1,
          "sub": [
            {
              "id": 2217395,
              "name": "Sri Lanka. Super League",
              "counter": 1,
              "sport_id": 1,
              "countryId": 208
            }
          ]
        }
      ]
    }
  ]
}

Shortened Prematch Response Example

This excerpt also comes from a real English response. The arrays have been shortened.

{
  "status": 1,
  "page": "/v1/menu",
  "body": [
    {
      "id": 1,
      "name": "Football",
      "counter": 2573,
      "sub": [
        {
          "id": 4,
          "name": "Australia",
          "counter": 104,
          "sport_id": 1,
          "sub": [
            {
              "id": 149213,
              "name": "Australia Cup",
              "counter": 2,
              "sport_id": 1,
              "countryId": 4
            }
          ]
        }
      ]
    }
  ]
}

Match counts change continuously. The counter values above represent the sports line only at the time the responses were retrieved.

Top-level Response Fields

Sport Fields

Each top-level object in the body array describes one sport.

Country Fields

Each object in body[].sub describes one country.

Tournament Fields

Each object in body[].sub[].sub describes one tournament.

Pay attention to the exact JSON field names:

• the sport ID in a country object is named sport_id;
• the country ID in a tournament object is named countryId, with an uppercase I.

Do not replace countryId with country_id when parsing the response.

Ready-to-use Icons

You can use standard SportAPI icons for sports, countries, and tournaments. Take the required ID from the menu response and insert it into the corresponding URL.

Sport Icon

Use the sport id from body[].id:

https://cdn.sportapi.net/sports/v1/color/{sportId}.webp

Example for a sport with id: 1:

https://cdn.sportapi.net/sports/v1/color/1.webp

Country Icon

Use the country id from body[].sub[].id:

https://cdn.sportapi.net/flags/v1/color/{countryId}.webp

Example for a country with id: 218:

https://cdn.sportapi.net/flags/v1/color/218.webp

Tournament Icon

Use the tournament id from body[].sub[].sub[].id:

https://cdn.sportapi.net/tournaments/v1/color/{tournamentId}.webp

Example for a tournament with id: 118737:

https://cdn.sportapi.net/tournaments/v1/color/118737.webp

Understanding counter

The counter field represents the number of matches available for the selected line type at the time of the response:

• for a tournament — the number of matches in that tournament;
• for a country — the number of matches across all its tournaments;
• for a sport — the number of matches across all its countries and tournaments.

In the saved responses, the sum of child counter values matches the parent object’s counter. This value is dynamic and may change with the next request.

Important Considerations

Request Live and Prematch Separately

Both line types use the same response structure but contain different sets of sports, countries, and tournaments. Use type=live for the Live menu and type=line for Prematch.

Empty Tournament Names

The tournament name field may contain an empty string. The saved English Live response contained four such tournaments; the saved English Prematch response contained none.

The client interface must handle these entries correctly. For example, it can temporarily display the tournament ID or omit the tournament until a name becomes available. Do not invent a tournament name from other fields.

Menu Contents Depend on Access

The API returns only data available to the supplied key. The available sports and languages depend on the client’s subscription.

Snapshot of the English Responses

These figures describe specific responses retrieved on August 21, 2026. They are not a permanent description of the API.

Full unabridged responses:

• Live, Russian
• Prematch, Russian
• Live, English
• Prematch, English

The files contain only API response bodies. No API key is stored in them.

Using the Method

Typical workflow:

1. Request menu for the required line type and language.
2. Show the available sports from the body array.
3. After the user selects a sport, open the countries from its sub array.
4. After the user selects a country, open the tournaments from its sub array.
5. Pass the selected sportId and tournamentId to events to retrieve matches.
6. On the next menu update, account for sections and counter values having changed.

Use Only Current IDs from the Menu

menu returns only sports, countries, and tournaments that currently have matches for the selected line type. Do not store their IDs as a permanent list of available sections.

If a tournament’s only match ends or disappears, the tournament will no longer be returned in the next response. If no other matches remain for the sport, the sport itself will also disappear from the menu.

Before requesting events, verify that the selected sportId and tournamentId are present in the current menu for the same live or line type.

Update Frequency

Recommended request frequency for menu:

• Live — no more than once every 20 seconds;
• Prematch (line) — no more than once every 60 seconds.

See Data Update Guidelines for more details.

Key, subscription, and parameter errors are documented in Error Handling.