/api/meta/openapi
GETTersedia

Dokumen OpenAPI

Deskripsi OpenAPI 3.0 untuk API publik, dihasilkan dari katalog dan dari tabel kolom yang diturunkan dari respons nyata.

GET/api/meta/openapi

Permintaan

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.

KolomTipeSatuanDeskripsi
openapistring—Versi spesifikasi OpenAPI dokumen ini.
infoobject—Judul, versi, dan deskripsi API.
info.titlestring—Judul API.
info.versionstring—Versi API.
info.descriptionstring—Deskripsi singkat tentang API dan konvensinya.
serversarray—URL dasar API.
servers[]object—Satu entri server.
servers[].urlstring—URL dasar yang ditambahkan di depan setiap path.
tagsarray—Kategori endpoint.
tags[]object—Satu kategori.
tags[].namestring—Nama.
tags[].descriptionstring—Deskripsi kategori.
pathsobject—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.{*}.getobject—Operasi GET.
paths.{*}.get.operationIdstring—ID endpoint, sama dengan ID dalam katalog.
paths.{*}.get.summarystring—Blok ringkasan.
paths.{*}.get.descriptionstring—Apa yang dikembalikan endpoint, beserta catatan tentang cakupan dan batasannya.
paths.{*}.get.tagsarray—Kategori endpoint.
paths.{*}.get.tags[]string—ID kategori.
paths.{*}.get.x-declared-statusstring—Ketersediaan yang dideklarasikan: `available`, `partial`, atau `unavailable`.
paths.{*}.get.x-cache-ttl-secondsnumbersMasa berlaku cache sisi server endpoint. bisa tidak ada
paths.{*}.get.parametersarray—Parameter permintaan. kosong pada sampel yang dipakai untuk menghasilkan tabel ini
paths.{*}.get.parameters[]object—Satu parameter.
paths.{*}.get.parameters[].namestring—Nama.
paths.{*}.get.parameters[].instring—Tempat parameter diletakkan: `query` atau `path`.
paths.{*}.get.parameters[].requiredboolean—`true` jika parameter wajib dikirim.
paths.{*}.get.parameters[].descriptionstring—Makna parameter.
paths.{*}.get.parameters[].schemaobject—JSON Schema nilai parameter (type, default, enum, minimum, maximum).
paths.{*}.get.parameters[].examplestring—Contoh nilai. bisa tidak ada
paths.{*}.get.responsesobject—Respons dengan status HTTP sebagai kuncinya; respons 200 memuat JSON Schema yang dihasilkan dari respons nyata.
componentsobject—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": [
      • { … 1 }
      ],
    • "tags": [
      • { … 2 },
      • { … 2 }
      ],
    • "paths": {
      • "/api/coin-heatmap": { … 1 },
      • "/api/coins/all": { … 1 }
      },
    • "components": {
      • "schemas": { … 1 },
      • "securitySchemes": { … 1 }
      }
    }

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

TersediaDiperiksa 2026-11-13 03:59:28 UTCHTTP 20037 msSkema sesuai

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 →

KodeHTTPArtiTindakan
INVALID_PARAM400Parameter wajib tidak ada atau suatu nilai tidak diterima. `param` menyebutkan nama parameternya jika diketahui.Jangan mengulang tanpa perubahan; perbaiki permintaannya.
UNAUTHORIZED401Header `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.
FORBIDDEN403Rute ini bukan bagian dari API publik (internal atau khusus akun).Jangan mengulang.
NOT_FOUND404Rute tidak dikenal, atau koin / bursa / dana yang diminta tidak ada.Jangan mengulang; periksa path dan pengenal terhadap katalog.
RATE_LIMITED429Jumlah permintaan melebihi batas per menit. `Retry-After` memberikan jumlah detik untuk menunggu.Tunggu selama `Retry-After`, lalu ulangi dengan backoff.
INTERNAL500Error 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_FAILED503Sumber 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.
UNAVAILABLE501 / 503Dataset 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_FAILED200Beberapa endpoint lama menjawab HTTP 200 dengan `success: false`. Selalu periksa `success`, bukan hanya status HTTP.Bergantung pada pesannya; perlakukan sebagai permintaan yang gagal.

Coba

GET/api/meta/openapiTersedia
Parameter

Tidak ada parameter.

URL permintaanhttps://www.coinboss.com/api/meta/openapi
Pilih endpoint lalu tekan “Kirim permintaan”. Respons, header, dan waktu tempuhnya akan muncul di sini.