Skip to content
Public API · v1

Pokékipe Public API

Ilmainen kilpailullinen Pokémon-analytiikka, johdettu Smogonin kuukausittaisista usage-stateista ja päivitetty joka kuukausi. Ei tarvetta tilille satunnaiseen käyttöön; minttaa henkilökohtainen avain Account Settingsistä nostaaksesi rate-limit-kattoa bulk-pulleihin.

  • Endpointit

    100+

  • Formaatit

    30+

  • Päivitys

    Kuukausittain

  • Auth

    Valinnainen

  • Lisenssi

    CC BY 4.0

Miksi tämä on olemassa

Mitä tämä API on, ja mitä se ei ole

Neljä asiaa tiedettäväksi ennen kuin kirjoitat yhdenkään koodirivin /api/v1/:tä vastaan.

Mitä tämä API on

Read-only JSON-pinta maailman kilpailullisen Pokémon-datan päällä. Kysy "mikä on meta Gen 9 OU:ssa 1500+ ELO:lla tässä kuussa?" tai "kuka counteroi tämän Pokémonin tämän turnauksen top cutissa?" ja saa yhden kutsun vastaus stabiileissa, dokumentoiduissa muodoissa.

Mistä data tulee

Smogonin kuukausittaiset taistelulogit (julkinen chaos JSON), viralliset turnausfeedit (Pokémon Company, VGC, Smogon Tour), ja community-lähteet kuten Limitless TCG community-tapahtumille. Pokékipe ajaa oman ingestion-, normalisointi- ja enrichment-pipelinen päälle, sitten uudelleen-exposaa siivotun tuloksen.

Mitä tämä API ei ole

Ei live Pokémon Showdown -silta, ei taistelusimulaattori, ei damage calculator -endpoint, ei teambuilding-engine. Ne työkalut elävät websivustolla. API on datakerros, jonka päällä ne istuvat.

Credit upstreamille

Krediitti sinne minne se kuuluu. Smogon, chaos-formaatin JSON-exporterit ja pelaajacommunity, joka pelaa pelit joka kuukausi, ovat syy miksi tämä datasetti on olemassa. Pokékipe tekee siitä kyseltävän; se ei omista pohjadataa.

Aloita tästä

Ensimmäinen kutsusi, 30 sekunnissa

Kolme copy-paste-esimerkkiä, jotka hakevat formaattikatalogin. Ei API-avainta, ei setupia, ei rekisteröitymistä. Valitse kielitabisi, liimaa, aja.

curl -s https://pokekipe.com/api/v1/formats \
  | jq '.[0:3]'

Korvaa polku millä tahansa referenssissä alla listatulla endpointilla. Ensimmäinen kutsu pitäisi palautua alle sekunnissa lämmenneellä cachella.

Tunnistautuminen

Tunnistautuminen ja rate-limitit

Anonyymit kutsut toimivat satunnaiseen käyttöön. Henkilökohtainen avain (ilmainen, luodaan tilin asetuksista) nostaa rate-limit-katon analyytikoille ja työkalujen rakentajille, jotka hakevat dataa bulk-massalla. Avaimet eivät koskaan avaa uusia endpointteja; ne vain nostavat kattoa.

Anonyymi, ei avainta

Default

Tee kutsuja ilman headeria. Bucket on keyattu IP:hesi, joten pieni skripti tai LLM-agentti, joka tekee kourallisen pyyntöjä per sessio, ei koskaan laukaise limittiä.

  • Ei tiliä, ei rekisteröitymistä, ei headeria asetettavaksi.
  • Per-IP-bucket, sopii ad-hoc-skripteille ja LLM-agentin tool-uselle.
  • Osuu 429:ään jos sustainat bulk-pulleja; vaihda henkilökohtaiseen avaimeen.

per minuutti

60

per päivä

5,000

Autentikoitu, henkilökohtaisella avaimella

Suositeltu bulkkiin

Passaa avaimesi muodossa X-API-Key (tai Authorization: Bearer pk_live_…). Anonyymit kutsut toimivat rinnalla; avain vain nostaa kattoa, se ei avaa uusia endpointteja.

  • Per-user-bucket: IP-vaihdoksesi eivät resetoi counttia.
  • Korkeammat katot jokaisella per-route-limitillä.
  • Jopa 5 aktiivista avainta per tili, revokoitavissa milloin tahansa.

per minuutti

600

per päivä

100,000

Headerit jokaisessa vastauksessa

Jokainen onnistunut vastaus kantaa alla olevat rate-limit-headerit, jotta clientisi voi tahdittaa itsensä ilman retryjä. Lue ne kerran per vastaus ja backoffaa heti kun Remaining osuu muutamaan pyyntöön — älä odota nollaa.

HeaderMerkitys
X-RateLimit-TierMihin tasoon kuulut: anonyymi (ei avainta) tai autentikoitu (JWT tai API-avain resolvattu).
X-RateLimit-Limit-MinPer-minuutti-katto tasollesi (60 anonyymi, 600 autentikoitu).
X-RateLimit-Limit-DayPer-päivä-katto tasollesi (5 000 anonyymi, 100 000 autentikoitu).
X-RateLimit-Remaining-MinKutsuja jäljellä nykyisessä minuutti-ikkunassa. Hidasta kun tämä lähestyy nollaa.
X-RateLimit-Remaining-DayKutsuja jäljellä nykyisessä päiväikkunassa. Resetoituu samalla wall-clock-minuutilla joka päivä.
Retry-AfterLähetetään vain 429:llä. Odota tämä määrä sekunteja ennen retryä, yleensä alle 60 per-minuutti-ikkunassa.

Virheet

Virheet joita saatat nähdä

Standardit HTTP-statuskoodit. Body on aina JSON, jossa on "detail"-kenttä kuvaamassa mikä meni pieleen. Käsittele 4xx kontrahti-ongelmana (sinun pyyntösi) ja 5xx meidän ongelmana (retryä backoffilla).

200

OK

OK. Body on referenssissä dokumentoitu JSON-payload. Tyhjät arrayt tarkoittavat "ei rivejä", eivät "puuttuu" — käsittele ne datana, älä virheenä.

304

Not Modified

Not Modified. Cache-headerit validoitu. Käytä cachetettua bodya, ei tarvetta re-parselle. Palautetaan automaattisesti kun lähetät If-None-Match tai If-Modified-Since.

400

Bad Request

Bad Request. Query-parametri tai body-muoto on väärin. Detail-viesti nimeää tarkan kentän. Älä retryä korjaamatta inputtia.

401

Unauthorized

Unauthorized. Pyyntö tarvitsi API-avaimen tai sessionin eikä saanut kumpaakaan, tai credentialit olivat invalideja/revokoituja. Älä jatka spämmäystä — uudista credentiaali.

404

Not Found

Not Found. Polkua tai resurssia ei ole olemassa. Per-Pokémon-routeissa tämä tarkoittaa usein, että formaatilla ei ole vielä usage-dataa kyseiselle Pokémonille — ei typoa sinun päässä.

429

Too Many Requests

Too Many Requests. Osuit rate-limit-kattoon. Lue Retry-After ja odota — exponential backoff on hyvää etikettiä mutta harvoin tarpeen, koska ikkuna on lyhyt.

500

Server Error

Internal Server Error. Jokin räjähti meidän puolella. Retryä kerran muutaman sekunnin päästä; jos jatkuu, pingaa meitä Discordissa pyynnön URL:n kanssa.

503

Service Unavailable

Service Unavailable. Joko deployaamme tai olemme hetkellisesti ylikuormassa. Retryä backoffilla. Status-päivitykset menevät community Discordiin.

Perussäännöt

Käyttöehdot

Neljä perussääntöä. Lue kerran, säästä tulevalta itseltäsi Discord-pingi.

Credit upstreamille

Attribuutio vaaditaan redistribuoitaessa tai uudelleenjulkaistaessa. Krediittaa Pokékipe (linkki osoitteeseen https://pokekipe.com), ja krediittaa Smogon pohjana olevasta chaos JSONista jonka he julkaisevat joka kuukausi.

Best-effort, ei SLA:ta

Best-effort, ei SLA:ta. Data tarjoillaan "as is" ilman uptime-takuuta. Cacheta aggressiivisesti ja degradoi gracefulisti kun endpoint on hidas tai palauttaa 429:n.

Versiointi

Skeemat /api/v1/:n alla pysyvät backwards-yhteensopivina v1-elinkaaren sisällä. Breaking changet menevät /api/v2/:een ennakkoilmoituksella Discordissa ja sunset-headerilla deprekoidulla polulla.

Kaupallinen käyttö

Kaupallinen käyttö on sallittu CC BY 4.0 -lisenssillä. Jos rakennat jotain tämän API:n päälle, kuulisimme siitä mielellämme community Discordissa.

Referenssi · OpenAPI 3Live, kolme paneelia

Selaa jokaista endpointtia, kaikki yhdessä paikassa

Selaa jokaista endpointtia kuvauksineen, parametritaulukkoineen, request- ja response-skeemoineen, sekä koodisampleineen curlissa, JavaScriptissä ja Pythonissa. Hae koko API yhdestä laatikosta, deep-linkkaa mihin tahansa operaatioon, jaa URL.

  • 100+ endpointtia
  • ·
  • 3-pane navigaatio, sisältö, samplet
  • ·
  • full-text-haku
  • ·
  • live request -samplet