Dokumen OpenAPI
Deskripsi OpenAPI 3.0 untuk API publik, dihasilkan dari katalog dan dari tabel kolom yang diturunkan dari respons nyata.
/api/meta/openapiPermintaan
Endpoint ini tidak menerima parameter.
Contoh permintaan
curl -s "https://www.coinboss.com/api/meta/openapi"Kolom respons
Tabel kolom dihasilkan dari respons nyata, sehingga memuat persis apa yang dikembalikan endpoint. Path memakai a[] untuk item array dan {*} untuk objek yang kuncinya berupa nama dinamis seperti koin atau bursa.
| Kolom | Tipe | Satuan | Deskripsi |
|---|---|---|---|
| openapi | string | — | Versi spesifikasi OpenAPI dokumen ini. |
| info | object | — | Judul, versi, dan deskripsi API. |
| info.title | string | — | Judul API. |
| info.version | string | — | Versi API. |
| info.description | string | — | Deskripsi singkat tentang API dan konvensinya. |
| servers | array | — | URL dasar API. |
| servers[] | object | — | Satu entri server. |
| servers[].url | string | — | URL dasar yang ditambahkan di depan setiap path. |
| tags | array | — | Kategori endpoint. |
| tags[] | object | — | Satu kategori. |
| tags[].name | string | — | Nama. |
| tags[].description | string | — | Deskripsi kategori. |
| paths | object | — | Endpoint, dengan path sebagai kuncinya. kunci dinamis: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list |
| paths.{*} | object | — | Operasi yang tersedia pada satu path. |
| paths.{*}.get | object | — | Operasi GET. |
| paths.{*}.get.operationId | string | — | ID endpoint, sama dengan ID dalam katalog. |
| paths.{*}.get.summary | string | — | Blok ringkasan. |
| paths.{*}.get.description | string | — | Apa yang dikembalikan endpoint, beserta catatan tentang cakupan dan batasannya. |
| paths.{*}.get.tags | array | — | Kategori endpoint. |
| paths.{*}.get.tags[] | string | — | ID kategori. |
| paths.{*}.get.x-declared-status | string | — | Ketersediaan yang dideklarasikan: `available`, `partial`, atau `unavailable`. |
| paths.{*}.get.x-cache-ttl-seconds | number | s | Masa berlaku cache sisi server endpoint. bisa tidak ada |
| paths.{*}.get.parameters | array | — | Parameter permintaan. kosong pada sampel yang dipakai untuk menghasilkan tabel ini |
| paths.{*}.get.parameters[] | object | — | Satu parameter. |
| paths.{*}.get.parameters[].name | string | — | Nama. |
| paths.{*}.get.parameters[].in | string | — | Tempat parameter diletakkan: `query` atau `path`. |
| paths.{*}.get.parameters[].required | boolean | — | `true` jika parameter wajib dikirim. |
| paths.{*}.get.parameters[].description | string | — | Makna parameter. |
| paths.{*}.get.parameters[].schema | object | — | JSON Schema nilai parameter (type, default, enum, minimum, maximum). |
| paths.{*}.get.parameters[].example | string | — | Contoh nilai. bisa tidak ada |
| paths.{*}.get.responses | object | — | Respons dengan status HTTP sebagai kuncinya; respons 200 memuat JSON Schema yang dihasilkan dari respons nyata. |
| components | object | — | Skema bersama, termasuk body galat yang dipakai setiap endpoint. |
Dihasilkan 2026-11-11 23:03 UTC dari 1 respons nyata.
Contoh respons
/api/meta/openapi · Respons nyata yang direkam 2026-11-13 03:59:28 UTC. Array dan map yang panjang dipersingkat untuk tampilan: tags berisi 21 item; paths berisi 298 item; paths.{*}.get.responses berisi 5 item; paths.{*}.get.parameters berisi 3 item; components.schemas.Error.properties.code.enum berisi 9 item.
- "openapi""3.0.3"
- "info"
- "title""CoinBoss API"
- "version""v1 (2026.11.12)"
- "description""Public market-data API of CoinBoss. Generated from the endpoint catalog and from field tables inferred from real responses."
- "servers"
- "tags"
- "paths"
- "/api/coin-heatmap"
- "/api/coins/all"
- "components"
- "schemas"
- "securitySchemes"
Detail
- Autentikasi
- Tidak ada. Endpoint publik.
- Batas permintaan
- 1200 permintaan per menit per IP
- Cache server
- 5m
- Mikro-cache edge
- 10s
- Stempel waktu
- Milidetik epoch Unix (UTC) kecuali deskripsi kolom menyatakan lain
- Format respons
- json
- Stabilitas
- Stabil
- Tersedia sejak
- 2026-11-11
Status langsung
Ketersediaan, 30 hari terakhir
100% dari 408 pemeriksaan lolos
Error
Panggilan yang gagal memiliki satu bentuk yang sama di semua endpoint. Daftar lengkapnya ada di halaman error. Error dan batas permintaan →
| Kode | HTTP | Arti | Tindakan |
|---|---|---|---|
| INVALID_PARAM | 400 | Parameter wajib tidak ada atau suatu nilai tidak diterima. `param` menyebutkan nama parameternya jika diketahui. | Jangan mengulang tanpa perubahan; perbaiki permintaannya. |
| UNAUTHORIZED | 401 | Header `CB-API-KEY` dikirim tetapi kuncinya tidak dikenal atau sudah dicabut. Data publik tidak memerlukan kunci — hapus header tersebut atau gunakan kunci yang valid. | Jangan mengulang tanpa perubahan. |
| FORBIDDEN | 403 | Rute ini bukan bagian dari API publik (internal atau khusus akun). | Jangan mengulang. |
| NOT_FOUND | 404 | Rute tidak dikenal, atau koin / bursa / dana yang diminta tidak ada. | Jangan mengulang; periksa path dan pengenal terhadap katalog. |
| RATE_LIMITED | 429 | Jumlah permintaan melebihi batas per menit. `Retry-After` memberikan jumlah detik untuk menunggu. | Tunggu selama `Retry-After`, lalu ulangi dengan backoff. |
| INTERNAL | 500 | Error server yang tidak terduga. Pesannya sengaja dibuat generik; sertakan `request_id` saat melaporkannya. | Ulangi sekali setelah beberapa detik; laporkan beserta ID permintaan jika masih terjadi. |
| UPSTREAM_FAILED | 503 | Sumber data di balik endpoint ini tidak menjawab tepat waktu. Tidak ada angka usang atau angka pengganti yang dikembalikan sebagai gantinya. | Ulangi dengan backoff; periksa halaman status. |
| UNAVAILABLE | 501 / 503 | Dataset untuk sementara belum siap (cache sedang diisi) atau endpoint belum memiliki sumber publik yang sah. | Ulangi nanti; katalog menandai endpoint yang memang tidak tersedia secara desain. |
| REQUEST_FAILED | 200 | Beberapa endpoint lama menjawab HTTP 200 dengan `success: false`. Selalu periksa `success`, bukan hanya status HTTP. | Bergantung pada pesannya; perlakukan sebagai permintaan yang gagal. |
Coba
/api/meta/openapiTersediaTidak ada parameter.
https://www.coinboss.com/api/meta/openapiLainnya di kategori ini
- Matriks kualitas data (tampilan kolektor) /api/sd/quality
- Katalog API /api/meta/catalog
- Catatan perubahan dan kebijakan versi /api/meta/changelog
- Dokumentasi endpoint /api/meta/endpoint
- Dokumen OpenAPI /api/meta/openapi
- Matriks kualitas data /api/meta/quality
- Status layanan /api/meta/status
- Memeriksa apakah suatu simbol koin dikenal oleh platform /api/coin-exists
- Peta simbol koin ke path ikon yang di-host secara lokal /api/coin-icons
- Ringkasan agregat halaman koin /api/content/coin
- Ringkasan bagian seluruh situs /api/content/summary
- Tabel kurs valas fiat /api/currency/fx
- Peta id bursa ke path ikon yang di-host secara lokal /api/exchange-icons
- Pemeriksaan liveness /api/health
- Statistik halaman riset /api/research/stats