/api/meta/catalog
GETKullanılabilirFRESH

API kataloğu

Herkese açık her uç nokta; kategorisi, beyan edilen ve canlı durumu, önbellek TTL'si ve son yoklama sonucuyla birlikte. Ayrıca istek sınırları ve hata kodu tablosu.

GET/api/meta/catalog

İstek

Bu uç nokta parametre almaz.

Örnek istek

curl -s "https://www.coinboss.com/api/meta/catalog"

Yanıt alanları

Alan tablosu gerçek yanıtlardan üretilir; dolayısıyla uç noktanın tam olarak ne döndürdüğünü listeler. Yollarda a[] dizi öğelerini, {*} ise coin veya borsa gibi dinamik bir adla anahtarlanan nesneleri gösterir.

AlanTürBirimAçıklama
successboolean—İstek başarılıysa true. Başarısızlık durumunda gövde `{ success: false, code, error, request_id }` olur.
schemastring—Bu yanıtın şema kimliği (`coinboss.meta.catalog/1`).
nownumbermsYanıtın oluşturulduğu andaki sunucu zamanı.
api_versionstring—Herkese açık API'nin sürümü (`v1`).
catalog_versionstring—Uç nokta kataloğunun sürümü; `2026.11.11` gibi bir yayın tarihi.
base_pathstring—Tüm uç noktaların paylaştığı yol öneki (`/api`).
summaryobject—Özet bloğu.
summary.totalnumber—Toplam.
summary.availablenumber—Verinin mevcut olup olmadığı.
summary.partialnumber—Beklenen verinin yalnızca bir kısmı mevcutsa true.
summary.degradednumbercountCanlı durumu `degraded` olan uç nokta sayısı.
summary.downnumbercountCanlı durumu `down` olan uç nokta sayısı.
summary.unavailablenumber—Verisi bulunmayan öğeler, nedenleriyle birlikte. Hiçbir zaman 0 olarak bildirilmez.
summary.unknownnumbercountCanlı durumu `unknown` olan (yakın tarihli yoklama sonucu bulunmayan) uç nokta sayısı.
probeobject—Canlı durumların dayandığı uç nokta yoklamasının durumu: son çalışma zamanı, yaşı, aralığı ve güncel olup olmadığı.
probe.last_run_atnumbermsZaman damgası.
probe.age_snumbersBu satırın son güncellenmesinden bu yana geçen saniye.
probe.interval_snumbersİki yoklama çalışması arasındaki planlanan aralık (300).
probe.freshboolean—Son yoklama çalışması 20 dakikadan yeniyse true; false olduğunda uç nokta durumları `unknown` olarak bildirilir.
probe.errornull—Hata mesajı (yalnızca başarısızlık durumunda bulunur).
categoriesarray—En az bir uç nokta içeren uç nokta kategorileri; durum bazında uç nokta sayılarıyla birlikte.
categories[]object—Tek bir kategori: `id`, `title`, `desc` ve her durumdaki uç nokta sayısı.
categories[].idstring—Tanımlayıcı.
categories[].titlestring—Kategorinin görüntülenen başlığı.
categories[].descstring—Kategorinin tek cümlelik açıklaması; yazılmamışsa null.
categories[].totalnumber—Toplam.
categories[].availablenumber—Verinin mevcut olup olmadığı.
categories[].partialnumber—Beklenen verinin yalnızca bir kısmı mevcutsa true.
categories[].degradednumbercountKategorinin canlı durumu `degraded` olan uç nokta sayısı.
categories[].downnumbercountKategorinin canlı durumu `down` olan uç nokta sayısı.
categories[].unavailablenumber—Verisi bulunmayan öğeler, nedenleriyle birlikte. Hiçbir zaman 0 olarak bildirilmez.
categories[].unknownnumbercountKategorinin canlı durumu `unknown` olan uç nokta sayısı.
endpointsarray—Belgelenen her uç nokta, canlı durumuyla birlikte.
endpoints[]object—Tek bir uç nokta: kimlik, yol, beyan edilen ve canlı durum, önbellek ömrü, parametre adları ve son yoklama sonucu.
endpoints[].idstring—Tanımlayıcı.
endpoints[].catstring—Uç noktanın ait olduğu kategorinin kimliği.
endpoints[].kindstring—Tür.
endpoints[].methodstring—Formül / yöntem notları.
endpoints[].pathstring—Uç noktanın istek yolu; `:name` segmentleri yol parametreleridir.
endpoints[].titlestring—Uç noktanın kısa görüntülenen başlığı.
endpoints[].summarystring—Özet bloğu.
endpoints[].declaredstring—Yoklamadan bağımsız olarak katalogda beyan edilen durum: `available`, `partial` veya `unavailable`.
endpoints[].statusstring—Durum.
endpoints[].status_reasonstring|null—`status` değerinin neden `available` olmadığı, düz metin olarak; öyleyse null.
endpoints[].stabilitystring—`stable`, `beta` (alan kümesi 90 günlük bildirim olmadan değişebilir) veya `legacy` (çalışmaya devam eder, yerine geçen bir uç nokta vardır).
endpoints[].sincestring|null—Dönemin başlangıcı.
endpoints[].ttl_snumber|nullsUç nokta yanıtlarının sunucu tarafı önbellek ömrü; önbelleğe alınmıyorsa veya uygulanamıyorsa null.
endpoints[].paramsarray—Uç noktanın kabul ettiği tüm parametrelerin adları. bu tabloyu üretmek için kullanılan örneklerde boş
endpoints[].params[]string—Tek bir parametre adı.
endpoints[].requiredarray—Gönderilmesi zorunlu parametrelerin adları. bu tabloyu üretmek için kullanılan örneklerde boş
endpoints[].probeobject—Uç noktanın son yoklama sonucu: kontrol zamanı, HTTP durumu, `ok`, `schema_ok`, yanıt süresi, boyut, veri yaşı, son başarı ve art arda başarısızlık sayısı; hiç yoklanmadıysa null.
endpoints[].probe.checked_atnumbermsZaman damgası.
endpoints[].probe.httpnumber—En son yoklama isteğinin HTTP durumu.
endpoints[].probe.okboolean—En son yoklama isteği geçerli bir JSON gövdesiyle HTTP 200 döndürdüyse `true`.
endpoints[].probe.schema_okboolean—Yoklanan yanıt belgelenen alan tablosuyla eşleştiyse `true`; alan tablosu yoksa `null`.
endpoints[].probe.latency_msnumbermsEn son yoklama isteğinin yanıt süresi.
endpoints[].probe.bytesnumberbytesYoklanan yanıt gövdesinin boyutu.
endpoints[].probe.qualitynull—Yoklanan yanıtın bildirdiği `meta.quality` (FRESH / PARTIAL / STALE …); uç nokta bunu bildirmiyorsa `null`.
endpoints[].probe.data_age_snumber|nullsOlaydan bu yana geçen saniye.
endpoints[].probe.last_ok_atnumbermsZaman damgası.
endpoints[].probe.fail_streaknumbercountArt arda başarısız yoklama sayısı; son yoklama başarılı olduysa 0.
endpoints[].required[]string—Tek bir zorunlu parametre adı.
rate_limitobject—Herkese açık API'nin istek sınırı kuralları.
rate_limit.window_snumbersSayım penceresinin uzunluğu (60).
rate_limit.anonymous_per_minnumbercountAPI anahtarı gönderilmediğinde istemci IP'si başına izin verilen dakikalık istek sayısı.
rate_limit.scopestring—İsteklerin nasıl sayıldığını belirten metin: anonimken istemci IP'si başına, `CB-API-KEY` başlığı gönderildiğinde anahtar başına.
rate_limit.key_tiers_per_minobject—Her API anahtarı kademesi için izin verilen dakikalık istek sayısı; kademe adına göre anahtarlanır.
rate_limit.key_tiers_per_min.hobbyistnumbercount`hobbyist` kademesindeki anahtarlar için dakikalık istek sayısı.
rate_limit.key_tiers_per_min.startupnumbercount`startup` kademesindeki anahtarlar için dakikalık istek sayısı.
rate_limit.key_tiers_per_min.standardnumbercount`standard` kademesindeki anahtarlar için dakikalık istek sayısı.
rate_limit.key_tiers_per_min.professionalnumbercount`professional` kademesindeki anahtarlar için dakikalık istek sayısı.
rate_limit.exemptarray—Sınıra dahil edilmeyen yol kalıpları.
rate_limit.exempt[]string—Muaf tutulan tek bir yol kalıbı; örneğin `/api/coin-icon/*`.
rate_limit.headersarray—İstek sınırı durumunu bildiren yanıt başlıklarının adları.
rate_limit.headers[]string—Tek bir başlık adı; örneğin `X-RateLimit-Remaining`.
rate_limit.on_exceedobject—Sınır aşıldığında döndürülenler: `http` durumu ve hata `code` değeri.
rate_limit.on_exceed.httpnumber—Sınır aşıldığında döndürülen HTTP durumu (429).
rate_limit.on_exceed.codestring—Kod.
errorsarray—API'nin döndürebileceği hata kodları; her biri HTTP durumu, anlamı ve yeniden deneme önerisiyle birlikte.
errors[]object—Tek bir hata kodu.
errors[].codestring—Kod.
errors[].httpnumber|string—Bu kodla birlikte gönderilen HTTP durumu; birden fazlası geçerliyse `501 / 503` gibi bir dize.
errors[].meaningstring—Hatanın ne anlama geldiği.
errors[].retrystring—Yeniden denenip denenmeyeceğine ve nasıl deneneceğine ilişkin öneri.
errors[].legacyboolean—Yalnızca, HTTP 200'ü `success: false` ile yanıtlayan eski uç noktaların kullandığı kodda bulunur ve true değerindedir. bulunmayabilir
status_legendobject—Her uç nokta durumunun düz metin tanımı.
status_legend.availablestring—Verinin mevcut olup olmadığı.
status_legend.partialstring—Beklenen verinin yalnızca bir kısmı mevcutsa true.
status_legend.degradedstring—`degraded` durumunun tanımı.
status_legend.downstring—`down` durumunun tanımı.
status_legend.unavailablestring—Verisi bulunmayan öğeler, nedenleriyle birlikte. Hiçbir zaman 0 olarak bildirilmez.
status_legend.unknownstring—`unknown` durumunun tanımı.
metaobject—Bu yanıtın zarfı: şema kimliği, üreten sistem, zaman damgaları, önbellek ömrü ve güncellik.
meta.schemastring—Bu yanıtın şema kimliği; üst düzeydeki `schema` ile aynı değer.
meta.sourcearray—Değerin nereden geldiği.
meta.source[]object—Değerin nereden geldiği.
meta.source[].systemstring—Veriyi üreten sistem; geliştirici merkezi uç noktaları için her zaman `coinboss`.
meta.source[].componentstring—Verinin arkasındaki bileşen: uç nokta yoklaması ve veri kalitesi devriyesi.
meta.observed_atnull—Zaman damgası.
meta.received_atnumbermsZaman damgası.
meta.fetched_atnumbermsCoinBoss'un veriyi kaynaktan getirdiği zaman.
meta.windowstring—Pencere.
meta.cache_ttl_snumbersBu yanıtın sunucu tarafı önbellek ömrü.
meta.qualitystring—Uç nokta yoklaması son 20 dakika içinde rapor verdiyse `FRESH`, aksi hâlde `STALE`.
meta.is_staleboolean—Satır güncellik penceresinden eskiyse true; eskimiş satırlar toplamlarda kullanılmaz.
meta.fallbackstring—Girdileri eskimiş veya eksik olduğunda bu uç noktanın ne döndürdüğüne ilişkin düz metin not.

Üretilme zamanı: 2026-11-11 23:01 UTC; kaynak: 1 gerçek yanıt.

Örnek yanıt

/api/meta/catalog · Gerçek yanıt, yakalanma zamanı: 2026-11-13 03:53:45 UTC. Uzun diziler ve eşlemeler görüntüleme için kısaltılmıştır: errors: 9 öğe içeriyordu; endpoints: 299 öğe içeriyordu; categories: 21 öğe içeriyordu.

  • {
    • "success": true,
    • "schema": "coinboss.meta.catalog/1",
    • "now": 1794542025566,
    • "api_version": "v1",
    • "catalog_version": "2026.11.12",
    • "base_path": "/api",
    • "summary": {
      • "total": 299,
      • "available": 256,
      • "partial": 17,
      • "degraded": 17,
      • "down": 8,
      • "unavailable": 1,
      • "unknown": 0
      },
    • "probe": {
      • "last_run_at": 1794541726312,
      • "age_s": 299,
      • "interval_s": 300,
      • "fresh": true,
      • "error": null
      },
    • "categories": [
      • { … 10 },
      • { … 10 }
      ],
    • "endpoints": [
      • { … 16 },
      • { … 16 }
      ],
    • "rate_limit": {
      • "window_s": 60,
      • "anonymous_per_min": 1200,
      • "scope": "per client IP for anonymous requests; per key when a CB-API-KEY header is sent",
      • "key_tiers_per_min": { … 4 },
      • "exempt": [ … 1 ],
      • "headers": [ … 4 ],
      • "on_exceed": { … 2 }
      },
    • "errors": [
      • { … 4 },
      • { … 4 }
      ],
    • "status_legend": {
      • "available": "last probe returned HTTP 200 and the response matched the documented schema",
      • "partial": "works, but exchange / field coverage is incomplete (see status_reason)",
      • "degraded": "responding, but schema drift or stale data was detected by the last probe",
      • "down": "last probe failed",
      • "unavailable": "documented for completeness; no lawful public source yet, the endpoint returns nulls or is not served",
      • "unknown": "no probe result within the last 20 minutes"
      },
    • "meta": {
      • "schema": "coinboss.meta.catalog/1",
      • "source": [ … 1 ],
      • "observed_at": null,
      • "received_at": 1794541726312,
      • "fetched_at": 1794542025566,
      • "window": "latest",
      • "cache_ttl_s": 30,
      • "quality": "FRESH",
      • "is_stale": false,
      • "fallback": "when the probe has not reported within 20 minutes every endpoint status becomes \"unknown\""
      }
    }

Ayrıntılar

Kimlik doğrulama
Yok. Herkese açık uç nokta.
İstek sınırı
IP başına dakikada 1200 istek
Sunucu önbelleği
30s
Edge mikro önbelleği
10s
Güncelleme sıklığı
İstek anında katalog dosyasından ve en son yoklama sonuçlarından yeniden oluşturulur (yoklama 5 dakikada bir çalışır).
Veri kaynakları
CoinBoss uç nokta kataloğu + sd_api_probe (API yoklamasının yaptığı gerçek çağrıların sonuçları).
Zaman damgaları
Alan açıklamasında aksi belirtilmedikçe Unix epoch milisaniyesi (UTC)
Yanıt biçimi
json
Kararlılık
Kararlı
Kullanıma sunulma
2026-11-11

Canlı durum

KullanılabilirKontrol: 2026-11-13 03:53:45 UTCHTTP 2006 msŞema eşleşiyorEn yeni veri noktası 5m öncesine ait

Erişilebilirlik, son 30 gün

408 kontrolde başarı oranı: %100

Hatalar

Başarısız çağrılar tüm uç noktalarda aynı yapıyı paylaşır. Tam liste hatalar sayfasındadır. Hatalar ve istek sınırları →

KodHTTPAnlamıNe yapmalı
INVALID_PARAM400Zorunlu bir parametre eksik ya da bir değer kabul edilmiyor. Biliniyorsa `param` parametrenin adını verir.Değiştirmeden yeniden denemeyin; isteği düzeltin.
UNAUTHORIZED401`CB-API-KEY` başlığı gönderildi, ancak anahtar bilinmiyor veya iptal edilmiş. Herkese açık veriler anahtar gerektirmez; başlığı kaldırın veya geçerli bir anahtar kullanın.Değiştirmeden yeniden denemeyin.
FORBIDDEN403Bu rota herkese açık API'nin parçası değildir (dahilî veya yalnızca hesaba özel).Yeniden denemeyin.
NOT_FOUND404Bilinmeyen rota ya da istenen coin / borsa / fon yok.Yeniden denemeyin; yolu ve tanımlayıcıları katalogla karşılaştırarak kontrol edin.
RATE_LIMITED429Dakika başına sınırdan fazla istek gönderildi. `Retry-After`, beklenecek saniye sayısını verir.`Retry-After` süresi kadar bekleyin, ardından artan beklemeyle yeniden deneyin.
INTERNAL500Beklenmeyen sunucu hatası. Mesaj bilinçli olarak geneldir; hatayı bildirirken `request_id` değerini belirtin.Birkaç saniye sonra bir kez yeniden deneyin; sorun sürerse istek kimliğiyle birlikte bildirin.
UPSTREAM_FAILED503Bu uç noktanın arkasındaki veri kaynağı zamanında yanıt vermedi. Yerine eskimiş veya ikame rakamlar döndürülmez.Artan beklemeyle yeniden deneyin; durum sayfasını kontrol edin.
UNAVAILABLE501 / 503Veri kümesi geçici olarak hazır değil (önbellek ısınıyor) ya da uç noktanın henüz yasal bir herkese açık kaynağı yok.Daha sonra yeniden deneyin; katalog, tasarım gereği mevcut olmayan uç noktaları işaretler.
REQUEST_FAILED200Bazı eski uç noktalar HTTP 200 ile `success: false` yanıtı verir. Yalnızca HTTP durumunu değil, her zaman `success` değerini de kontrol edin.Mesaja bağlıdır; başarısız bir istek olarak ele alın.

Deneyin

GET/api/meta/catalogKullanılabilir
Parametreler

Parametre yok.

İstek URL'sihttps://www.coinboss.com/api/meta/catalog
Bir uç nokta seçip “İstek gönder” düğmesine basın. Yanıt, başlıklar ve süre bilgisi burada görünür.