API Awam · v1

API Awam Pokékipe

Analitik Pokémon kompetitif percuma, diterbitkan daripada statistik penggunaan bulanan Smogon dan disegarkan setiap bulan. Tiada akaun diperlukan untuk penggunaan kasual; jana kunci peribadi daripada Tetapan Akaun untuk menaikkan siling had kadar untuk tarikan pukal.

Permulaan Pantas Buka rujukan

Endpoint
100+
Format
30+
Segar Semula
Bulanan
Auth
Pilihan
Lesen
CC BY 4.0

Kenapa ini wujud

Apa API ini, dan apa yang ia bukan

Empat perkara perlu tahu sebelum anda tulis satu baris kod terhadap /api/v1/.

Apa API ini

Permukaan JSON read-only di atas data Pokémon kompetitif dunia. Tanya "apa meta di Gen 9 OU pada 1500+ ELO bulan ini?" atau "siapa counter Pokémon ini di top cut kejohanan ini?" dan dapat jawapan satu panggilan dengan bentuk stabil dan didokumenkan.

Dari mana data datang

Log pertempuran bulanan Smogon (chaos JSON awam), feed kejohanan rasmi (Pokémon Company, VGC, Smogon Tour), dan sumber komuniti seperti Limitless TCG untuk acara dijalankan komuniti. Pokékipe menjalankan saluran paip pengingestian, normalisasi, dan pengayaan sendiri di atas, kemudian dedahkan semula hasil bersih.

Apa API ini bukan

Bukan jambatan langsung Pokémon Showdown, bukan simulator pertempuran, bukan endpoint kalkulator damage, bukan enjin teambuilding. Alat itu hidup di laman web. API ialah lapisan data yang ia duduk atas.

Kredit hulu

Kredit di tempat yang berhak. Smogon, pengeksport JSON format chaos, dan komuniti pemain yang main game setiap bulan adalah sebab dataset ini wujud. Pokékipe menjadikannya boleh disoal; ia tidak memiliki data asas.

Mula

Panggilan pertama anda, dalam 30 saat

Tiga contoh copy-paste yang ambil katalog format. Tiada kunci API, tiada setup, tiada signup. Pilih tab bahasa, paste, jalankan.

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

Ganti laluan dengan mana-mana endpoint tersenarai dalam rujukan di bawah. Panggilan pertama patut pulang dalam bawah sesaat pada cache panas.

Pengesahan

Pengesahan dan had kadar

Panggilan tanpa nama berfungsi untuk penggunaan kasual. Kunci peribadi (percuma, dijana daripada tetapan akaun anda) menaikkan siling had kadar untuk penganalisis dan pembina alat yang menarik data secara pukal. Kunci tidak pernah membuka endpoint baharu; ia hanya menaikkan siling.

Tanpa nama, tiada kunci

Lalai

Buat panggilan tanpa sebarang header. Bucket dikunci pada IP anda, jadi skrip kecil atau agen LLM yang buat segelintir permintaan setiap sesi tidak akan tersandung had.

Tiada akaun, tiada signup, tiada header untuk set.
Bucket per IP, sesuai untuk skrip ad-hoc dan tool-use agen LLM.
Terkena 429 jika anda kekalkan tarikan pukal; tukar ke kunci peribadi.

per minit

per hari

5,000

Disahkan, dengan kunci peribadi

Disarankan untuk pukal

Hantar kunci anda sebagai X-API-Key (atau Authorization: Bearer pk_live_…). Panggilan tanpa nama terus berfungsi seiring; kunci hanya menaikkan siling, ia tidak buka endpoint baharu.

Bucket per pengguna: perubahan IP anda tidak akan reset kiraan.
Siling lebih tinggi pada setiap had per laluan.
Sehingga 5 kunci aktif per akaun, boleh dibatalkan bila-bila masa.

per minit

600

per hari

100,000

Jana kunci API

Header pada setiap respons

Setiap respons yang berjaya membawa header had kadar di bawah supaya klien anda boleh atur kadar sendiri tanpa cuba semula. Baca sekali setiap respons dan backoff sebaik sahaja Remaining sampai beberapa permintaan, bukan sifar.

Header	Maksud
X-RateLimit-Tier	Tier mana yang anda jatuh: tanpa nama (tiada kunci) atau disahkan (JWT atau API key diselesaikan).
X-RateLimit-Limit-Min	Siling per minit untuk tier anda (60 tanpa nama, 600 disahkan).
X-RateLimit-Limit-Day	Siling per hari untuk tier anda (5 000 tanpa nama, 100 000 disahkan).
X-RateLimit-Remaining-Min	Panggilan tinggal dalam tetingkap minit semasa. Perlahankan apabila ini hampir sifar.
X-RateLimit-Remaining-Day	Panggilan tinggal dalam tetingkap hari semasa. Reset pada minit jam dinding yang sama setiap hari.
Retry-After	Dihantar pada 429 sahaja. Tunggu seberapa saat ini sebelum cuba semula, biasanya bawah 60 untuk tetingkap per minit.

Ralat

Ralat yang anda mungkin nampak

Kod status HTTP standard. Badan sentiasa JSON dengan medan "detail" yang menerangkan apa yang silap. Layan 4xx sebagai masalah kontrak (permintaan anda) dan 5xx sebagai masalah kami (cuba semula dengan backoff).

200

OK. Badan ialah muatan JSON yang didokumenkan dalam rujukan. Array kosong bermaksud "tiada baris", bukan "hilang", anggap ia sebagai data, bukan kegagalan.

304

Not Modified

Not Modified. Header cache telah disahkan. Guna badan yang dicache, tiada huraian semula diperlukan. Dipulangkan secara automatik apabila anda hantar If-None-Match atau If-Modified-Since.

400

Bad Request

Bad Request. Parameter kueri atau bentuk badan salah. Mesej detail menamakan medan yang tepat. Jangan cuba semula tanpa membetulkan input.

401

Unauthorized

Unauthorized. Permintaan memerlukan kunci API atau sesi tetapi tidak dapat sama sekali, atau kelayakan tidak sah/dibatalkan. Jangan terus menembak, terbitkan semula kelayakan.

404

Not Found

Not Found. Laluan atau sumber tidak wujud. Untuk laluan per-Pokémon, ini selalunya bermaksud format belum mempunyai data penggunaan untuk Pokémon itu, bukan typo di pihak anda.

429

Too Many Requests

Too Many Requests. Anda terkena siling had kadar. Baca Retry-After dan tunggu, exponential backoff adalah etika baik tetapi jarang perlu kerana tetingkapnya pendek.

500

Server Error

Internal Server Error. Sesuatu meletup di pihak kami. Cuba semula sekali selepas beberapa saat; jika berterusan, ping kami di Discord dengan URL permintaan.

503

Service Unavailable

Service Unavailable. Kami sama ada sedang deploy atau terlebih beban sementara. Cuba semula dengan backoff. Kemas kini status disiarkan di Discord komuniti.

Peraturan asas

Syarat penggunaan

Empat peraturan asas. Baca sekali, jimat ping Discord diri masa depan anda.

Kredit hulu

Atribusi diperlukan apabila mengedar semula atau menerbitkan semula. Kredit Pokékipe (pautan ke https://pokekipe.com), dan kredit Smogon untuk chaos JSON asas yang mereka terbitkan setiap bulan.

Best-effort, tiada SLA

Best-effort, tiada SLA. Data disajikan "as is" tanpa jaminan uptime. Cache agresif dan degrade dengan baik apabila endpoint perlahan atau pulangkan 429.

Versioning

Skema bawah /api/v1/ kekal serasi ke belakang dalam kitaran hayat v1. Perubahan breaking pergi ke /api/v2/ dengan notis awal di Discord dan header sunset pada laluan dideprekasi.

Penggunaan komersial

Penggunaan komersial dibenarkan di bawah CC BY 4.0. Jika anda bina sesuatu di atas API ini, kami sukar dengar tentangnya di Discord komuniti.

Rujukan · OpenAPI 3Langsung, tiga panel

Layari setiap endpoint, semuanya di satu tempat

Layari setiap endpoint dengan penerangan, jadual parameter, skema permintaan dan respons, dan sampel kod dalam curl, JavaScript, dan Python. Cari seluruh API dalam satu kotak, deep-link ke mana-mana operasi, kongsi URL.

100+ endpoint
·
3-pane navigasi, kandungan, sampel
·
carian teks penuh
·
sampel permintaan langsung

Buka rujukan penuh Atau ambil spec OpenAPI 3 mentah