Skip to main content

Classes​

This endpoint allows you to retrieve the classes. You can use the alpha parameter to get a specific class as a country.

Multi-language: This feature allows the user to manually change the language of the API response by adding value to the lang attribute. Example: lang=en.

Pagination: The endpoint uses an offset and limit system. Specify the offset and limit parameters to fetch the desired range of results. The maximum and default number of results per request is 50.

Update Period: The endpoint is updated several times per day.
Recommended Calls: Limit calls to 1 per day.

You can get the image of the category by calling the following url: https://images.sportdevs.com/{hash_image}.png

Use Cases​

Get classes
https://aussie-rules.sportdevs.com/classes

Get class based on the id
https://aussie-rules.sportdevs.com/classes?id=eq.{id}

Get classes based on the alpha
https://aussie-rules.sportdevs.com/classes?alpha=eq.{alpha}

Query Parameters
  • id integer

    Default value: eq.5

    The id of the class

  • alpha character varying

    Default value: eq.AU

    The alpha name of the country

  • offset string

    Default value: 0

    Limiting and Pagination

  • limit string

    Default value: 50

    Limiting and Pagination

  • lang string

    Default value: en

    Multi-language

Responses

OK

Schema array
  • id integer

    The id of the class

    Note: This is a Primary Key.

  • name text

    The name of the class

  • flag text

    The flag of the class

  • alpha character varying

    Possible values: <= 2 characters

    The alpha name of the country

  • importance integer

    The importance of the class specified with a number

  • hash_image character varying

    Possible values: <= 64 characters

    The name of the image

Loading...