Olympic Games - 2024 - API

A API de Jogos Olímpicos é uma API que traz os dados reais dos jogos olímpicos. Ela é utilizada pelo Mini Projeto Codante .

Trata-se de uma série de endpoints que fornecem informações sobre os eventos, locais, disciplinas e países participantes dos Jogos Olímpicos.

A API de Jogos Olímpicos do Codante.io é uma API pública e gratuita. Ela é atualizada em tempo real (5 minutos de atraso) com os dados dos jogos olímpicos de 2024.

Autenticação

A API de jogos olímpicos do Codante.io não requer autenticação para acessar os endpoints.

Rate Limit

A API de Jogos Olímpicos do Codante.io possui um limite de taxa de 100 solicitações por minuto. Se você exceder esse limite, receberá um código de status 429. O uso indiscriminado também poderá levar ao bloqueio do seu IP.

Base URL

A URL base para a API de pedidos do Codante.io é https://apis.codante.io/olympic-games.

GET/events

Lista de Jogos/Eventos

Este é o endpoint principal da API. Lista todos os eventos, com opções de filtro. Traz, para cada evento os competidores, o local, a data, o nome do evento, a flag se o evento está acontecendo agora, dentre outros. Esse endpoint é paginado e traz 10 eventos por página.

Atributos opcionais

  • Name
    country
    Type
    string
    Description

    Filtra por país usando código de 3 letras (ex: "BRA"). Para a lista completa, vide endpoint countries.

  • Name
    discipline
    Type
    string
    Description

    Filtra por disciplina/esporte usando código de 3 letras. Para a lista completa, vide endpoint disciplines.

  • Name
    gender
    Type
    string
    Description

    Filtra por gênero usando código de 1 letra (ex: "M"). Lista dos gêneros disponíveis M W X O.

  • Name
    venue
    Type
    string
    Description

    Filtra por local usando código de 3 letras. Para a lista completa, vide endpoint venues.

  • Name
    date
    Type
    string
    Description

    Filtra por data (YYYY-MM-DD).

  • Name
    competitor
    Type
    string
    Description

    Filtra por nome do competidor ou nome da equipe em casos de jogos de equipes.

  • Name
    page
    Type
    number
    Description

    Filtra por página. Padrão é 1.

Request

GET
/events
  curl -G https://apis.codante.io/olympic-games/events \
    -d page=1

Response

{
  "data": [
  {
    "id": 3407,
    "day": "2024-07-24",
    "discipline_name": "Football",
    "discipline_pictogram": "https://codante.s3.amazonaws.com/codante-apis/olympic-games/pictograms/FBL.avif",
    "name": null,
    "venue_name": "Geoffroy-Guichard Stadium",
    "event_name": "Men",
    "detailed_event_name": "Men's Group B",
    "start_date": "2024-07-24T15:00:00+02:00",
    "end_date": "2024-07-24T16:45:00+02:00",
    "status": "Finished",
    "is_medal_event": 0,
    "is_live": 0,
    "gender_code": "M",
    "competitors": [
      {
        "country_id": "Argentina",
        "country_flag_url": "https://codante.s3.amazonaws.com/codante-apis/olympic-games/flags/ARG.png",
        "competitor_name": "Argentina",
        "position": 0,
        "result_position": "",
        "result_winnerLoserTie": "L",
        "result_mark": "1"
      },
      {
        "country_id": "Marrocos",
        "country_flag_url": "https://codante.s3.amazonaws.com/codante-apis/olympic-games/flags/MAR.png",
        "competitor_name": "Morocco",
        "position": 1,
        "result_position": "",
        "result_winnerLoserTie": "W",
        "result_mark": "2"
      }
    ]
  },
  ...
],
  "links": {
    "first": "...",
    "last": "...",
    "prev": "...",
    "next": "..."
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "...",
    "per_page": 10,
    "to": 10,
    "total": 100
  }
}
GET/events/{id}

Jogo por ID

Exibe detalhes de um evento específico pelo ID.

Request

GET
/events/{id}
  curl -G https://apis.codante.io/olympic-games/events/1 \
    -d page=1

Response

{
  "data": {
    "id": 3407,
    "day": "2024-07-24",
    "discipline_name": "Football",
    "discipline_pictogram": "https://codante.s3.amazonaws.com/codante-apis/olympic-games/pictograms/FBL.avif",
    "name": null,
    "venue_name": "Geoffroy-Guichard Stadium",
    "event_name": "Men",
    "detailed_event_name": "Men's Group B",
    "start_date": "2024-07-24T15:00:00+02:00",
    "end_date": "2024-07-24T16:45:00+02:00",
    "status": "Finished",
    "is_medal_event": 0,
    "is_live": 0,
    "competitors": [
      {
        "country_id": "Argentina",
        "country_flag_url": "https://codante.s3.amazonaws.com/codante-apis/olympic-games/flags/ARG.png",
        "competitor_name": "Argentina",
        "position": 0,
        "result_position": "",
        "result_winnerLoserTie": "L",
        "result_mark": "1"
      },
      {
        "country_id": "Marrocos",
        "country_flag_url": "https://codante.s3.amazonaws.com/codante-apis/olympic-games/flags/MAR.png",
        "competitor_name": "Morocco",
        "position": 1,
        "result_position": "",
        "result_winnerLoserTie": "W",
        "result_mark": "2"
      }
    ]
  },
}

List Venues

Lista todos os locais dos eventos. Traz o nome e a URL oficial do local.

Request

GET
/venues
  curl -G https://apis.codante.io/olympic-games/venues

Response

Response

{
  "data": [
    {
      "id": "AQC",
      "name": "Aquatics Centre",
      "url": "https://olympics.com/en/paris-2024/venues/aquatics-centre"
    },
    {
      "id": "BCY",
      "name": "Bercy Arena",
      "url": "https://olympics.com/en/paris-2024/venues/bercy-arena"
    },
  ...
]
}
GET/disciplines

Lista de Esportes

Lista todas as disciplinas (esportes). Traz os pictogramas (ícones) de cada esporte.

Request

GET
/disciplines
  curl -G https://apis.codante.io/olympic-games/disciplines

Response

Response

{
  "data": [
    {
      "id": "BK3",
      "name": "3x3 Basketball",
      "pictogram_url": "https://codante.s3.amazonaws.com/codante-apis/olympic-games/pictograms/BK3.avif"
    },
    {
      "id": "ARC",
      "name": "Archery",
      "pictogram_url": "https://codante.s3.amazonaws.com/codante-apis/olympic-games/pictograms/ARC.avif"
    },
    ...
  ]
}
GET/countries

Lista de Medalhas e Países

Lista todos os países participantes ordenados pelo ranking de medalhas. Traz as bandeiras de cada um dos países bem como quantidades de medalhas de ouro, prata, bronze e totais.

Traz também dois rankings: o oficial, determinado pelo tipo de medalhas (rank) - e o ranking de medalhas por total de medalhas (rank_total_medals).

Request

GET
/countries
  curl -G https://apis.codante.io/olympic-games/countries

Response

Response

{
  "data": [
    {
      "id": "KOR",
      "name": "República da Coréia",
      "continent": "ASI",
      "flag_url": "https:\/\/codante.s3.amazonaws.com\/codante-apis\/olympic-games\/flags\/KOR.png",
      "gold_medals": 5,
      "silver_medals": 3,
      "bronze_medals": 1,
      "total_medals": 9,
      "rank": 1,
      "rank_total_medals": 4
    },
    {
      "id": "JPN",
      "name": "Japão",
      "continent": "ASI",
      "flag_url": "https:\/\/codante.s3.amazonaws.com\/codante-apis\/olympic-games\/flags\/JPN.png",
      "gold_medals": 5,
      "silver_medals": 2,
      "bronze_medals": 4,
      "total_medals": 11,
      "rank": 2,
      "rank_total_medals": 3
    },
    ...
  ],
  "links": {
    "first": "...",
    "last": "...",
    "prev": "...",
    "next": "..."
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "...",
    "per_page": 20,
    "to": 20,
    "total": 200
  }
}