/api/meta/endpoint
GETKullanılabilirFRESH

Uç nokta dokümantasyonu

Tek bir uç noktanın tam dokümantasyonu: parametreler, gerçek yanıtlardan üretilen alan tablosu, yakalanmış bir örnek yanıt, doğrulanmış örnekler, 30 günlük yoklama geçmişi, hatalar ve sınırlar.

GET/api/meta/endpoint

İstek

Sorgu parametreleri

AdTürZorunluVarsayılanİzin verilen değerlerAçıklama
idstringZorunlu——Katalogdaki uç nokta kimliği (örneğin `sd-oi`). Bilinmeyen kimlikler 404 döndürür. Örnek: sd-oi

Örnek istek

curl -s "https://www.coinboss.com/api/meta/endpoint?id=sd-oi"

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.endpoint/1`).
nownumbermsYanıtın oluşturulduğu andaki sunucu zamanı.
endpointobject—Uç noktanın katalog kaydı. Eşleme anahtarları `id`, `path`, `status`, `params`, `category`, `sources`, `units`, `formula` gibi öznitelik adlarıdır. dinamik anahtarlar: id,cat,kind,method,path,title
endpoint.{*}array|number|object|string|null—Tek bir özniteliğin değeri: metin, sayı, liste (`params`, `required`, `ts_fields`) veya nesne (`probe`, `category`, `example_query`); ayarlanmamışsa null.
endpoint.{*}[]object|string—Liste türündeki bir özniteliğin öğesi: `params` içinde bir parametre tanımı veya `required` / `ts_fields` içinde bir ad. bulunmayabilir
endpoint.{*}[].namestring—Ad. bulunmayabilir
endpoint.{*}[].instring—Parametrenin gönderildiği yer: `query` veya `path`. bulunmayabilir
endpoint.{*}[].typestring—Tür. bulunmayabilir
endpoint.{*}[].requiredboolean—Parametrenin gönderilmesi zorunluysa true. bulunmayabilir
endpoint.{*}[].defaultnull—Parametre belirtilmediğinde kullanılan değer; varsayılan yoksa null. bulunmayabilir
endpoint.{*}[].enumnull—Kabul edilen değerlerin listesi; parametre bir listeyle sınırlı değilse null. bulunmayabilir
endpoint.{*}[].minnull—Minimum. bulunmayabilir
endpoint.{*}[].maxnull—Maksimum. bulunmayabilir
endpoint.{*}[].examplestring—Parametrenin örnek değeri; verilmemişse null. bulunmayabilir
endpoint.{*}[].descstring—Parametrenin açıklaması. bulunmayabilir
endpoint.{*}.checked_atnumbermsZaman damgası. bulunmayabilir
endpoint.{*}.httpnumber—En son yoklama isteğinin HTTP durumu. bulunmayabilir
endpoint.{*}.okboolean—En son yoklama isteği geçerli bir JSON gövdesiyle HTTP 200 döndürdüyse `true`. bulunmayabilir
endpoint.{*}.schema_okboolean—Yoklanan yanıt belgelenen alan tablosuyla eşleştiyse `true`; alan tablosu yoksa `null`. bulunmayabilir
endpoint.{*}.latency_msnumbermsEn son yoklama isteğinin yanıt süresi. bulunmayabilir
endpoint.{*}.bytesnumberbytesYoklanan yanıt gövdesinin boyutu. bulunmayabilir
endpoint.{*}.qualitynull—Yoklanan yanıtın bildirdiği `meta.quality` (FRESH / PARTIAL / STALE …); uç nokta bunu bildirmiyorsa `null`. bulunmayabilir
endpoint.{*}.data_age_snumber|nullsOlaydan bu yana geçen saniye. bulunmayabilir
endpoint.{*}.last_ok_atnumbermsZaman damgası. bulunmayabilir
endpoint.{*}.fail_streaknumbercountArt arda başarısız yoklama sayısı; son yoklama başarılı olduysa 0. bulunmayabilir
endpoint.{*}.idstring—Tanımlayıcı. bulunmayabilir
endpoint.{*}.titlestring—Uç noktanın kategorisinin görüntülenen başlığı (`category` içinde). bulunmayabilir
endpoint.{*}.coinstring—Coin sembolü, büyük harfle (örneğin BTC). bulunmayabilir
fieldsarray—Yanıtın alan tablosu; gerçek yanıtlardan çıkarılır. Tablo üretilmemişse null.
fields[]object—Tek bir yanıt alanı: `path`, `type`, `unit`, `desc` ve bayraklar.
fields[].pathstring—Alanın yanıttaki yolu: iç içe yapı için `a.b`, dizi öğeleri için `[]`, bir eşlemenin değerleri için `{*}`.
fields[].typestring—Tür.
fields[].unitstring|null—Bu nesnedeki değerlerin birimi.
fields[].descstring—Alanın açıklaması; yazılmamışsa null.
fields[].optionalboolean—Alan, örneklenen yanıtların en az birinde eksikse bulunur ve true değerindedir. bulunmayabilir
fields[].mapboolean—Nesne, sabit alanlar yerine veriye bağlı anahtarlara (coinler, borsalar, tarihler) sahip bir eşlemeyse bulunur ve true değerindedir. bulunmayabilir
fields[].keysarray—Eşlemede görülen anahtarlardan bir örneklem; yalnızca `map` değeri true olan alanlarda bulunur. bulunmayabilir
fields[].keys[]string—Tek bir örnek anahtar. bulunmayabilir
fields_generated_atnumbermsZaman damgası.
fields_generated_fromarray—Alan tablosunun, gerçek yanıtlarından çıkarıldığı istek URL'leri; tablo yoksa null.
fields_generated_from[]string—Sorgu dizesiyle birlikte örneklenen tek bir istek yolu.
exampleobject—Yoklamanın yakaladığı son başarılı gerçek yanıt: `request`, `captured_at`, `truncated` (kısaltılan dizilerin özgün uzunlukları) ve `body`; yoksa null.
example.requeststring—Yakalanan örneği üreten istek (yol ve sorgu dizesi).
example.captured_atnumbermsZaman damgası.
example.truncatedobject—Yakalanan örnekte nelerin kısaltıldığı: her dizi veya eşleme için dışarıda bırakılan öğe sayısı. Anahtarları, belgelenen uç noktaya bağlıdır.
example.bodyobject—Belgelenen uç noktanın yakalanan yanıtı, kısaltılmış hâliyle. Yapısı `fields` tarafından tanımlanan yapıdır.
verified_samplesobject|null—Yoklamanın ek örnek isteklerinin sonuçları (`at`; sorgu, HTTP durumu, yanıt süresi ve şema kontrolüyle birlikte `samples`); hiç çalışmadıysa null.
verified_samples.atnumbermsEk örneklerin en son kontrol edildiği zaman.
verified_samples.samplesarray—Örnek sayısı.
verified_samples.samples[]object—Örnek sayısı.
verified_samples.samples[].queryobject—Örnek isteğin sorgu parametreleri.
verified_samples.samples[].query.coinstring—Coin sembolü, büyük harfle (örneğin BTC). bulunmayabilir
verified_samples.samples[].httpnumber—Döndürülen HTTP durumu.
verified_samples.samples[].okboolean—Örnek, bekleneni döndürdüyse `true` (geçerli JSON ile HTTP 200 veya beklenen hata durumu).
verified_samples.samples[].latency_msnumbermsÖrnek isteğin yanıt süresi.
verified_samples.samples[].schema_okboolean|null—Örnek yanıt belgelenen alan tablosuyla eşleştiyse `true`; kontrol edilmediyse `null`.
verified_samples.samples[].qualitynull—Örnek yanıtın bildirdiği `meta.quality`; bildirilmediyse `null`.
verified_samples.samples[].notestring|null—Not.
probe_detailnull—Son yoklamanın bulduğu şema farkları: `missing`, `mismatched` ve `undocumented` alan yolları; fark yoksa null.
uptime_30dobject—Bu uç noktanın son 30 gündeki yoklama kontrolleri: toplamlar, başarı yüzdesi ve gün bazında dağılım.
uptime_30d.checksnumbercountUç noktanın son 30 gündeki yoklama kontrolü sayısı (izleme daha geç başladıysa daha az gün).
uptime_30d.oknumbercountBu kontrollerden başarılı olanların sayısı.
uptime_30d.pctnumber%Yüzde.
uptime_30d.daysarray—Günlük değerler veya gün sayısı.
uptime_30d.days[]object—Günlük değerler veya gün sayısı.
uptime_30d.days[].daystring—Takvim günü (UTC).
uptime_30d.days[].checksnumbercountO günkü yoklama isteği sayısı.
uptime_30d.days[].oknumbercountO günkü başarılı yoklama isteği sayısı.
uptime_30d.days[].pctnumber%Yüzde.
uptime_30d.days[].avg_msnumbermsO günkü ortalama yanıt süresi; kontrol yoksa `null`.
uptime_30d.days[].max_msnumbermsO günkü en yavaş yanıt.
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
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.
relatedarray—Bu uç nokta dahil, aynı kategorideki tüm uç noktalar.
related[]object—Tek bir uç nokta: `id`, `path` ve `title`.
related[].idstring—Tanımlayıcı.
related[].pathstring—Uç noktanın istek yolu.
related[].titlestring—Uç noktanın kısa görüntülenen başlığı.
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).
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—Bu uç nokta son 20 dakika içinde yoklandıysa `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:03 UTC; kaynak: 3 gerçek yanıt.

Örnek yanıt

/api/meta/endpoint?id=sd-oi · 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; fields: 103 öğe içeriyordu; related: 6 öğe içeriyordu; endpoint: 35 öğe içeriyordu; uptime_30d.days: 3 öğe içeriyordu; verified_samples.samples: 4 öğe içeriyordu.

  • {
    • "success": true,
    • "schema": "coinboss.meta.endpoint/1",
    • "now": 1794542025825,
    • "endpoint": {
      • "id": "sd-oi",
      • "cat": "open-interest"
      },
    • "fields": [
      • { … 4 },
      • { … 4 }
      ],
    • "fields_generated_at": 1794438008862,
    • "fields_generated_from": [
      • "/api/sd/oi?coin=BTC",
      • "/api/sd/oi?coin=ETH",
      • "/api/sd/oi?coin=SOL",
      • "/api/sd/oi?coin=ARKM"
      ],
    • "example": {
      • "request": "/api/sd/oi?coin=BTC",
      • "captured_at": 1794541954384,
      • "truncated": { … 4 },
      • "body": { … 17 }
      },
    • "verified_samples": {
      • "at": 1794540459506,
      • "samples": [ … 2 ]
      },
    • "probe_detail": {
      • "missing": [],
      • "mismatched": [],
      • "undocumented": [ … 6 ]
      },
    • "uptime_30d": {
      • "checks": 410,
      • "ok": 410,
      • "pct": 100,
      • "days": [ … 2 ]
      },
    • "errors": [
      • { … 4 },
      • { … 4 }
      ],
    • "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 }
      },
    • "related": [
      • { … 3 },
      • { … 3 }
      ],
    • "probe": {
      • "last_run_at": 1794541726312,
      • "age_s": 300,
      • "interval_s": 300,
      • "fresh": true,
      • "error": null
      },
    • "meta": {
      • "schema": "coinboss.meta.endpoint/1",
      • "source": [ … 1 ],
      • "observed_at": null,
      • "received_at": 1794541954384,
      • "fetched_at": 1794542025825,
      • "window": "latest",
      • "cache_ttl_s": 30,
      • "quality": "FRESH",
      • "is_stale": false,
      • "fallback": "field table comes from the last schema generation; example is the last successful real response"
      }
    }

Doğrulanmış örnekler

Yoklama, yukarıdaki örneğin yanı sıra bu uç noktayı aşağıdaki parametrelerle de çağırır ve her seferinde şemayı kontrol eder.

ParametrelerHTTPYanıt süresiSonuç
id=sd-funding2002 msBaşarılı FRESH
id=liquidations-overview2002 msBaşarılı FRESH
—4002 msBaşarılı beklenen hatayı döndürür

Kontrol: 2026-11-13 03:29:26 UTC

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
Veri kaynakları
CoinBoss uç nokta kataloğu, API yoklamasının ürettiği şemalar, sd_api_probe.
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 2004 msŞema eşleşiyorEn yeni veri noktası 71s öncesine ait

Erişilebilirlik, son 30 gün

407 kontrolde başarı oranı: %99.75

Son yoklamanın saptadığı şema sapması
  • Dönüyor ama belgelenmemiş: probe_detail.missing, probe_detail.mismatched, probe_detail.undocumented, probe_detail.undocumented[]

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/endpointKullanılabilir
Parametreler

string — Endpoint id from the catalog (for example `sd-oi`). Unknown ids return 404.

İstek URL'sihttps://www.coinboss.com/api/meta/endpoint?id=sd-oi
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.