Pular para o conteúdo

Documentação da API

Gere imagens BMP 800×480 para displays E-Ink mostrando a programação das corridas de F1 nos modos 1bit, B/W/R, B/W/R/Y ou Spectra 6.

800×480 BMP 1bit / B/W/R / B/W/R/Y / Spectra 6 E-Ink REST API

GET /calendar.bmp

Gera um calendário de F1 como imagem BMP (800×480) para telas E-Ink 1bit, 4-bit B/W/R, 4-bit B/W/R/Y e Spectra 6.

Sem a combinação de year e round ou race_key, a próxima corrida é selecionada. Copie round ou race_key de /api/races/{year}. Exceção: race_key sem year retorna HTTP 400.

Estilo do circuito: track_style=relief · Fonte do mapa: track_source=jules · Destaques de cor: track_accent=all.

A altura e as divisões coloridas são decorativas. Usam-se as cores compatíveis com a tela. Para os quatro destaques, use display=spectra6.

GET /api/tracks — Todos os estilos, cores e circuitos. GET /api/tracks/{circuit_id} — Autores e licenças.

GET /api/tracks/{circuit_id}.{svg|png|bmp} · GET /preview/configure/calendar.png — Os mesmos parâmetros track_style, track_source, track_accent.

Madring · SVG · Credits

Parâmetros

Parameter Tipo Descrição
lang string Código do idioma para o texto do calendário
Valores: cs, de, en, es, fr, it, ja, nl, pl, pt-BR, sk, tr, zh-CN (padrão: en)
year integer Ano da temporada para uma corrida específica
opcional — ex. 2026
round integer Número da rodada na lista de corridas; ignorado sem year
opcional — ex. ?year=2026&round=5
race_key string Identificador da corrida de /api/races/{year}; requer year
opcional — ex. 2026-round-6-monaco-2026-06-07
tz string Fuso horário para os horários do cronograma (formato IANA)
opcional — ex. America/New_York, Europe/Prague (padrão: Europe/Prague)
display string Modo de saída para telas 1bit, B/W/R, B/W/R/Y ou Spectra 6
Valores: 1bit, bwr, bwry, spectra6 (padrão: 1bit)
weather boolean Ativa ou desativa a sobreposição de clima
Valores: true, false (padrão: true)
weather_type string Qual variante de dados meteorológicos renderizar
Valores: off, race_day, race, current (padrão: race_day)
track_style string Estilo do circuito
Valores: relief, poster, clean, lino, riso, screenprint, contours, geometric, blueprint, ribbon, mosaic, halftone, negative, papercut, typographic, artdeco, stencil, pixel (padrão: relief)
track_source string Fonte do mapa
Valores: jules, commons (padrão: jules)
track_accent string Destaques de cor
Valores: all, mono, red, yellow, blue, green, warm, red-blue, red-green, yellow-blue, yellow-green, cool, red-yellow-blue, red-yellow-green, red-blue-green, yellow-blue-green (padrão: all)

Resposta

Content-Type image/bmp
Dimensões 800×480
Profundidade de cor 1bit / 4-bit B/W/R / 4-bit B/W/R/Y / Spectra 6
Cache public, max-age=3600

As respostas BMP incluem ETag. Envie If-None-Match para receber 304 quando a imagem não tiver mudado.

Exemplos de código

# Download next race calendar
curl -o calendar.bmp "https://f1.inkycloud.click/calendar.bmp"

# With Czech language and timezone
curl -o calendar.bmp "https://f1.inkycloud.click/calendar.bmp?lang=cs&tz=Europe/Prague"

# Specific race (year and round)
curl -o calendar.bmp "https://f1.inkycloud.click/calendar.bmp?year=2026&round=6"

# B/W/R/Y output for four-color E-Ink
curl -o calendar.bmp "https://f1.inkycloud.click/calendar.bmp?display=bwry"
import httpx

async def get_f1_calendar(lang: str = "en", tz: str = "Europe/Prague"):
    """Download F1 calendar as BMP image."""
    async with httpx.AsyncClient() as client:
        response = await client.get(
            "https://f1.inkycloud.click/calendar.bmp",
            params={"lang": lang, "tz": tz}
        )
        response.raise_for_status()

        with open("calendar.bmp", "wb") as f:
            f.write(response.content)

        print("Calendar saved as calendar.bmp")

# Usage
import asyncio
asyncio.run(get_f1_calendar(lang="cs"))
// Fetch and display calendar
async function loadF1Calendar(lang = 'en', tz = 'Europe/Prague') {
    const url = new URL('https://f1.inkycloud.click/calendar.bmp');
    url.searchParams.set('lang', lang);
    url.searchParams.set('tz', tz);

    const response = await fetch(url);
    const blob = await response.blob();

    // Display in img element
    const img = document.getElementById('calendar');
    img.src = URL.createObjectURL(blob);
}

// Download as file
async function downloadCalendar() {
    const response = await fetch('/calendar.bmp?lang=cs');
    const blob = await response.blob();

    const link = document.createElement('a');
    link.href = URL.createObjectURL(blob);
    link.download = 'f1-calendar.bmp';
    link.click();
}

Uso com display E-Ink

Busque /calendar.bmp e exiba diretamente no seu display E-Ink. Intervalo de atualização recomendado: a cada 1 a 6 horas. Compatível com qualquer display E-Ink 800×480 (por exemplo, Waveshare 7.5", LaskaKit).

Para LaskaKit / zivyobraz.eu:

  1. 1 No zivyobraz.eu selecione como fonte de conteúdo: URL com imagem
  2. 2 Cole a URL: https://f1.inkycloud.click/calendar.bmp?lang=cs&tz=Europe/Prague
  3. 3 Defina o intervalo de atualização para 1-6 horas

GET /teams.bmp

Gere uma imagem BMP mostrando todas as equipes da F1 com seus pilotos, fotos e pontos do campeonato nos modos 1bit, B/W/R, B/W/R/Y ou Spectra 6.

Atribuição e licenças da imagem (artes dos circuitos CC BY 4.0, clima do Open-Meteo CC BY 4.0): veja Credits. As respostas também trazem um cabeçalho Link com rel="license".

Parâmetros

Parameter Tipo Descrição
lang string Código do idioma para o texto do calendário
Valores: cs, de, en, es, fr, it, ja, nl, pl, pt-BR, sk, tr, zh-CN (padrão: en)
year integer Ano da temporada para os dados das equipes
opcional — ex. 2026
display string Modo de saída do display
Valores: 1bit, bwr, bwry, spectra6 (padrão: 1bit)
extra string Painel opcional: none (padrão), countdown, flags, track, weather. Usa dados locais da temporada e clima em cache; painéis indisponíveis são omitidos.
tz string Optional IANA timezone for extra panels showing a time or date: countdown, flags, track, weather. Defaults to the server's DEFAULT_TIMEZONE; ignored for none or unavailable panels. Invalid values return HTTP 400. Also supported by /preview/configure/teams.png.

Resposta

Content-Type image/bmp
Dimensões 800×480
Profundidade de cor 1-bit / 4-bit / Spectra 6
Cache no-cache

Outros endpoints

GET /api/teams/{year}

Obter todas as equipes com pilotos e pontos de uma temporada (JSON)

GET /api/standings/leader

Obter os líderes atuais do campeonato (piloto e construtor)

/api/standings/leader/{year}

GET /api/races/{year}

Lista de todas as corridas de uma temporada

GET /api/race/{year}/{round}

Informações detalhadas da corrida, incluindo cronograma

GET /api/stats

Estatísticas de requisições nas últimas 24 horas

GET /api/stats/history

Histórico de requisições por hora; limit: 1–720 (padrão 168).

GET / POST /api/perf-metrics

GET: resumos de desempenho; hours: 1–720 (padrão 24). POST: valores numéricos de Web Vitals; metadados de visitantes e dispositivos são ignorados.

GET /preview/{screen_type}.png

GET /preview/configure/{screen_type}.png

Prévias PNG do calendário ou das equipes; lang seleciona o idioma. As prévias de configuração também aceitam display e weather_type para o calendário (padrão off).

extra — Painel opcional: none (padrão), countdown, flags, track, weather. Usa dados locais da temporada e clima em cache; painéis indisponíveis são omitidos.

track_style, track_source, track_accent — Estilo do circuito, Fonte do mapa, Destaques de cor (calendar).

GET /health/ready

Banco de dados, armazenamento com permissão de escrita e atualização das imagens; HTTP 200 quando o serviço está pronto, 503 caso contrário.

GET /health

Verificação de saúde do serviço

GET /api

API JSON — Documentação da API em formato JSON

As APIs de leitura de estatísticas exigem X-Admin-Token ou Authorization: Bearer <token> quando ADMIN_API_TOKEN está configurado. Com MINIMAL_DATA_MODE=true, todas as APIs de estatísticas retornam 410.

As requisições que excedem o limite de frequência retornam 429 com Retry-After.

Menu