Skip to main content

Matches Lineups​

This endpoint allows you to retrieve the lineups from matches. With this endpoint you can see the lineups from the match. This endpoint also has confirmed filed to check if the lineup is confirmed.

Fields in lineup:

FieldExplanation
formationThe formation of the lineup
player_color_primaryThe primary color of the players
player_color_numberThe number color of the players
player_color_outlineThe outline color of the players
goalkeeper_color_primaryThe primary color of the goalkeeper
goalkeeper_color_numberThe number color of the goalkeeper
goalkeeper_color_outlineThe outline color of the goalkeeper
playersThe players of the lineup

Fields in players:

FieldExplanation
player_idThe id of the player
shirt_numberThe shirt number of the player
jersey_numberThe jersey number of the player
positionThe position of the player
substituteIf the player is substituted

Resons for missing the match:

IdReason
0Other
1Injured
2Ill
3Suspended
11YellowCard
12YellowRedCard
13RedCard
21OnLoan

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 every 5 minutes. Recommended Calls: Limit calls to 1 every 5 minutes.

Use Cases​

Get lineups based on the id
https://american-football.sportmicro.com/matches-lineups?id=eq.{id}

Query Parameters
  • id integer

    The id of the lineup

    Example: eq.1
  • offset string

    Default value: 0

    Limiting and Pagination

    Example: 0
  • limit string

    Default value: 50

    Limiting and Pagination

    Example: 50
  • lang string

    Default value: en

    Multi-language

    Example: en
Responses

OK

Schema array
  • id integer

    The id of the lineup

    Note: This is a Primary Key.

  • confirmed boolean

    If the lineup is confirmed

  • home_team jsonb

    The lineup of the home team

  • away_team jsonb

    The lineup of the away team

Loading...