Skip to content

API_STRUCTURE.md

Latest commit

 

History

History
100 lines (88 loc) · 2.83 KB

API_STRUCTURE.md

File metadata and controls

100 lines (88 loc) · 2.83 KB

Estrutura dos Dados da API NBA

Este documento descreve a estrutura dos dados retornados pelos endpoints da API.

Endpoint /players/{player_id}

Retorna informações detalhadas de um jogador específico. A resposta inclui os seguintes campos:

{
    "PERSON_ID": "string",
    "PLAYER_LAST_NAME": "string",
    "PLAYER_FIRST_NAME": "string",
    "PLAYER_SLUG": "string",
    "TEAM_ID": "string",
    "TEAM_SLUG": "string",
    "IS_DEFUNCT": "string",
    "TEAM_CITY": "string",
    "TEAM_NAME": "string",
    "TEAM_ABBREVIATION": "string",
    "JERSEY_NUMBER": "string",
    "POSITION": "string",
    "HEIGHT": "string",
    "WEIGHT": "string",
    "COLLEGE": "string",
    "COUNTRY": "string",
    "DRAFT_YEAR": "string",
    "DRAFT_ROUND": "string",
    "DRAFT_NUMBER": "string",
    "ROSTER_STATUS": "string",
    "FROM_YEAR": "string",
    "TO_YEAR": "string",
    "PTS": "string",
    "REB": "string",
    "AST": "string",
    "STATS_TIMEFRAME": "string",
    "PLAYERCODE": "string"
}

Descrição dos Campos

Campo Descrição
PERSON_ID Identificador único do jogador
PLAYER_LAST_NAME Sobrenome do jogador
PLAYER_FIRST_NAME Nome do jogador
PLAYER_SLUG Identificador URL-friendly do jogador
TEAM_ID Identificador do time
TEAM_SLUG Identificador URL-friendly do time
IS_DEFUNCT Indica se o time ainda existe
TEAM_CITY Cidade do time
TEAM_NAME Nome do time
TEAM_ABBREVIATION Abreviação do nome do time
JERSEY_NUMBER Número da camisa do jogador
POSITION Posição do jogador
HEIGHT Altura do jogador
WEIGHT Peso do jogador
COLLEGE Universidade do jogador
COUNTRY País de origem do jogador
DRAFT_YEAR Ano do draft
DRAFT_ROUND Rodada do draft
DRAFT_NUMBER Número do draft
ROSTER_STATUS Status do jogador no elenco
FROM_YEAR Ano de início da carreira
TO_YEAR Ano de fim da carreira
PTS Média de pontos
REB Média de rebotes
AST Média de assistências
STATS_TIMEFRAME Período das estatísticas
PLAYERCODE Código único do jogador

Endpoint /teams/{team_id}

Retorna uma lista de jogadores de um time específico. Cada jogador na lista segue a mesma estrutura descrita acima.

Exemplo de Resposta

[
    {
        "PERSON_ID": "string",
        "PLAYER_LAST_NAME": "string",
        "PLAYER_FIRST_NAME": "string",
        ...
    },
    {
        "PERSON_ID": "string",
        "PLAYER_LAST_NAME": "string",
        "PLAYER_FIRST_NAME": "string",
        ...
    }
]

Observações

  1. Todos os campos são retornados como strings, mesmo quando representam números
  2. Alguns campos podem ser nulos dependendo da disponibilidade dos dados
  3. As estatísticas (PTS, REB, AST) são médias calculadas durante o período especificado em STATS_TIMEFRAME