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.
/api/meta/endpointİstek
Sorgu parametreleri
| Ad | Tür | Zorunlu | Varsayılan | İzin verilen değerler | Açıklama |
|---|---|---|---|---|---|
| id | string | Zorunlu | — | — | 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.
| Alan | Tür | Birim | Açıklama |
|---|---|---|---|
| success | boolean | — | İstek başarılıysa true. Başarısızlık durumunda gövde `{ success: false, code, error, request_id }` olur. |
| schema | string | — | Bu yanıtın şema kimliği (`coinboss.meta.endpoint/1`). |
| now | number | ms | Yanıtın oluşturulduğu andaki sunucu zamanı. |
| endpoint | object | — | 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.{*}[].name | string | — | Ad. bulunmayabilir |
| endpoint.{*}[].in | string | — | Parametrenin gönderildiği yer: `query` veya `path`. bulunmayabilir |
| endpoint.{*}[].type | string | — | Tür. bulunmayabilir |
| endpoint.{*}[].required | boolean | — | Parametrenin gönderilmesi zorunluysa true. bulunmayabilir |
| endpoint.{*}[].default | null | — | Parametre belirtilmediğinde kullanılan değer; varsayılan yoksa null. bulunmayabilir |
| endpoint.{*}[].enum | null | — | Kabul edilen değerlerin listesi; parametre bir listeyle sınırlı değilse null. bulunmayabilir |
| endpoint.{*}[].min | null | — | Minimum. bulunmayabilir |
| endpoint.{*}[].max | null | — | Maksimum. bulunmayabilir |
| endpoint.{*}[].example | string | — | Parametrenin örnek değeri; verilmemişse null. bulunmayabilir |
| endpoint.{*}[].desc | string | — | Parametrenin açıklaması. bulunmayabilir |
| endpoint.{*}.checked_at | number | ms | Zaman damgası. bulunmayabilir |
| endpoint.{*}.http | number | — | En son yoklama isteğinin HTTP durumu. bulunmayabilir |
| endpoint.{*}.ok | boolean | — | En son yoklama isteği geçerli bir JSON gövdesiyle HTTP 200 döndürdüyse `true`. bulunmayabilir |
| endpoint.{*}.schema_ok | boolean | — | Yoklanan yanıt belgelenen alan tablosuyla eşleştiyse `true`; alan tablosu yoksa `null`. bulunmayabilir |
| endpoint.{*}.latency_ms | number | ms | En son yoklama isteğinin yanıt süresi. bulunmayabilir |
| endpoint.{*}.bytes | number | bytes | Yoklanan yanıt gövdesinin boyutu. bulunmayabilir |
| endpoint.{*}.quality | null | — | Yoklanan yanıtın bildirdiği `meta.quality` (FRESH / PARTIAL / STALE …); uç nokta bunu bildirmiyorsa `null`. bulunmayabilir |
| endpoint.{*}.data_age_s | number|null | s | Olaydan bu yana geçen saniye. bulunmayabilir |
| endpoint.{*}.last_ok_at | number | ms | Zaman damgası. bulunmayabilir |
| endpoint.{*}.fail_streak | number | count | Art arda başarısız yoklama sayısı; son yoklama başarılı olduysa 0. bulunmayabilir |
| endpoint.{*}.id | string | — | Tanımlayıcı. bulunmayabilir |
| endpoint.{*}.title | string | — | Uç noktanın kategorisinin görüntülenen başlığı (`category` içinde). bulunmayabilir |
| endpoint.{*}.coin | string | — | Coin sembolü, büyük harfle (örneğin BTC). bulunmayabilir |
| fields | array | — | 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[].path | string | — | 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[].type | string | — | Tür. |
| fields[].unit | string|null | — | Bu nesnedeki değerlerin birimi. |
| fields[].desc | string | — | Alanın açıklaması; yazılmamışsa null. |
| fields[].optional | boolean | — | Alan, örneklenen yanıtların en az birinde eksikse bulunur ve true değerindedir. bulunmayabilir |
| fields[].map | boolean | — | Nesne, sabit alanlar yerine veriye bağlı anahtarlara (coinler, borsalar, tarihler) sahip bir eşlemeyse bulunur ve true değerindedir. bulunmayabilir |
| fields[].keys | array | — | 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_at | number | ms | Zaman damgası. |
| fields_generated_from | array | — | 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. |
| example | object | — | 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.request | string | — | Yakalanan örneği üreten istek (yol ve sorgu dizesi). |
| example.captured_at | number | ms | Zaman damgası. |
| example.truncated | object | — | 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.body | object | — | Belgelenen uç noktanın yakalanan yanıtı, kısaltılmış hâliyle. Yapısı `fields` tarafından tanımlanan yapıdır. |
| verified_samples | object|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.at | number | ms | Ek örneklerin en son kontrol edildiği zaman. |
| verified_samples.samples | array | — | Örnek sayısı. |
| verified_samples.samples[] | object | — | Örnek sayısı. |
| verified_samples.samples[].query | object | — | Örnek isteğin sorgu parametreleri. |
| verified_samples.samples[].query.coin | string | — | Coin sembolü, büyük harfle (örneğin BTC). bulunmayabilir |
| verified_samples.samples[].http | number | — | Döndürülen HTTP durumu. |
| verified_samples.samples[].ok | boolean | — | Örnek, bekleneni döndürdüyse `true` (geçerli JSON ile HTTP 200 veya beklenen hata durumu). |
| verified_samples.samples[].latency_ms | number | ms | Örnek isteğin yanıt süresi. |
| verified_samples.samples[].schema_ok | boolean|null | — | Örnek yanıt belgelenen alan tablosuyla eşleştiyse `true`; kontrol edilmediyse `null`. |
| verified_samples.samples[].quality | null | — | Örnek yanıtın bildirdiği `meta.quality`; bildirilmediyse `null`. |
| verified_samples.samples[].note | string|null | — | Not. |
| probe_detail | null | — | Son yoklamanın bulduğu şema farkları: `missing`, `mismatched` ve `undocumented` alan yolları; fark yoksa null. |
| uptime_30d | object | — | 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.checks | number | count | Uç noktanın son 30 gündeki yoklama kontrolü sayısı (izleme daha geç başladıysa daha az gün). |
| uptime_30d.ok | number | count | Bu kontrollerden başarılı olanların sayısı. |
| uptime_30d.pct | number | % | Yüzde. |
| uptime_30d.days | array | — | 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[].day | string | — | Takvim günü (UTC). |
| uptime_30d.days[].checks | number | count | O günkü yoklama isteği sayısı. |
| uptime_30d.days[].ok | number | count | O günkü başarılı yoklama isteği sayısı. |
| uptime_30d.days[].pct | number | % | Yüzde. |
| uptime_30d.days[].avg_ms | number | ms | O günkü ortalama yanıt süresi; kontrol yoksa `null`. |
| uptime_30d.days[].max_ms | number | ms | O günkü en yavaş yanıt. |
| errors | array | — | 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[].code | string | — | Kod. |
| errors[].http | number|string | — | Bu kodla birlikte gönderilen HTTP durumu; birden fazlası geçerliyse `501 / 503` gibi bir dize. |
| errors[].meaning | string | — | Hatanın ne anlama geldiği. |
| errors[].retry | string | — | Yeniden denenip denenmeyeceğine ve nasıl deneneceğine ilişkin öneri. |
| errors[].legacy | boolean | — | Yalnızca, HTTP 200'ü `success: false` ile yanıtlayan eski uç noktaların kullandığı kodda bulunur ve true değerindedir. bulunmayabilir |
| rate_limit | object | — | Herkese açık API'nin istek sınırı kuralları. |
| rate_limit.window_s | number | s | Sayım penceresinin uzunluğu (60). |
| rate_limit.anonymous_per_min | number | count | API anahtarı gönderilmediğinde istemci IP'si başına izin verilen dakikalık istek sayısı. |
| rate_limit.scope | string | — | İ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_min | object | — | 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.hobbyist | number | count | `hobbyist` kademesindeki anahtarlar için dakikalık istek sayısı. |
| rate_limit.key_tiers_per_min.startup | number | count | `startup` kademesindeki anahtarlar için dakikalık istek sayısı. |
| rate_limit.key_tiers_per_min.standard | number | count | `standard` kademesindeki anahtarlar için dakikalık istek sayısı. |
| rate_limit.key_tiers_per_min.professional | number | count | `professional` kademesindeki anahtarlar için dakikalık istek sayısı. |
| rate_limit.exempt | array | — | 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.headers | array | — | İ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_exceed | object | — | Sınır aşıldığında döndürülenler: `http` durumu ve hata `code` değeri. |
| rate_limit.on_exceed.http | number | — | Sınır aşıldığında döndürülen HTTP durumu (429). |
| rate_limit.on_exceed.code | string | — | Kod. |
| related | array | — | Bu uç nokta dahil, aynı kategorideki tüm uç noktalar. |
| related[] | object | — | Tek bir uç nokta: `id`, `path` ve `title`. |
| related[].id | string | — | Tanımlayıcı. |
| related[].path | string | — | Uç noktanın istek yolu. |
| related[].title | string | — | Uç noktanın kısa görüntülenen başlığı. |
| probe | object | — | Canlı durumların dayandığı uç nokta yoklamasının durumu: son çalışma zamanı, yaşı, aralığı ve güncel olup olmadığı. |
| probe.last_run_at | number | ms | Zaman damgası. |
| probe.age_s | number | s | Bu satırın son güncellenmesinden bu yana geçen saniye. |
| probe.interval_s | number | s | İki yoklama çalışması arasındaki planlanan aralık (300). |
| probe.fresh | boolean | — | Son yoklama çalışması 20 dakikadan yeniyse true; false olduğunda uç nokta durumları `unknown` olarak bildirilir. |
| probe.error | null | — | Hata mesajı (yalnızca başarısızlık durumunda bulunur). |
| meta | object | — | Bu yanıtın zarfı: şema kimliği, üreten sistem, zaman damgaları, önbellek ömrü ve güncellik. |
| meta.schema | string | — | Bu yanıtın şema kimliği; üst düzeydeki `schema` ile aynı değer. |
| meta.source | array | — | Değerin nereden geldiği. |
| meta.source[] | object | — | Değerin nereden geldiği. |
| meta.source[].system | string | — | Veriyi üreten sistem; geliştirici merkezi uç noktaları için her zaman `coinboss`. |
| meta.source[].component | string | — | Verinin arkasındaki bileşen: uç nokta yoklaması ve veri kalitesi devriyesi. |
| meta.observed_at | null | — | Zaman damgası. |
| meta.received_at | number | ms | Zaman damgası. |
| meta.fetched_at | number | ms | CoinBoss'un veriyi kaynaktan getirdiği zaman. |
| meta.window | string | — | Pencere. |
| meta.cache_ttl_s | number | s | Bu yanıtın sunucu tarafı önbellek ömrü. |
| meta.quality | string | — | Bu uç nokta son 20 dakika içinde yoklandıysa `FRESH`, aksi hâlde `STALE`. |
| meta.is_stale | boolean | — | Satır güncellik penceresinden eskiyse true; eskimiş satırlar toplamlarda kullanılmaz. |
| meta.fallback | string | — | 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"
- "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"
- "body"
- "verified_samples"
- "at"1794540459506
- "samples"
- "probe_detail"
- "missing"
- "mismatched"
- "undocumented"
- "uptime_30d"
- "checks"410
- "ok"410
- "pct"100
- "days"
- "errors"
- "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"
- "exempt"
- "headers"
- "on_exceed"
- "related"
- "probe"
- "last_run_at"1794541726312
- "age_s"300
- "interval_s"300
- "fresh"true
- "error"null
- "meta"
- "schema""coinboss.meta.endpoint/1"
- "source"
- "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.
| Parametreler | HTTP | Yanıt süresi | Sonuç |
|---|---|---|---|
| id=sd-funding | 200 | 2 ms | Başarılı FRESH |
| id=liquidations-overview | 200 | 2 ms | Başarılı FRESH |
| — | 400 | 2 ms | Baş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
Erişilebilirlik, son 30 gün
407 kontrolde başarı oranı: %99.75
- 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ı →
| Kod | HTTP | Anlamı | Ne yapmalı |
|---|---|---|---|
| INVALID_PARAM | 400 | Zorunlu 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. |
| UNAUTHORIZED | 401 | `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. |
| FORBIDDEN | 403 | Bu rota herkese açık API'nin parçası değildir (dahilî veya yalnızca hesaba özel). | Yeniden denemeyin. |
| NOT_FOUND | 404 | Bilinmeyen rota ya da istenen coin / borsa / fon yok. | Yeniden denemeyin; yolu ve tanımlayıcıları katalogla karşılaştırarak kontrol edin. |
| RATE_LIMITED | 429 | Dakika 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. |
| INTERNAL | 500 | Beklenmeyen 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_FAILED | 503 | Bu 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. |
| UNAVAILABLE | 501 / 503 | Veri 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_FAILED | 200 | Bazı 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
/api/meta/endpointKullanılabilirstring — Endpoint id from the catalog (for example `sd-oi`). Unknown ids return 404.
https://www.coinboss.com/api/meta/endpoint?id=sd-oiBu kategoride daha fazlası
- Veri kalitesi matrisi (toplayıcı görünümü) /api/sd/quality
- API kataloğu /api/meta/catalog
- Değişiklik günlüğü ve sürümleme politikası /api/meta/changelog
- Uç nokta dokümantasyonu /api/meta/endpoint
- OpenAPI belgesi /api/meta/openapi
- Veri kalitesi matrisi /api/meta/quality
- Servis durumu /api/meta/status
- Bir coin sembolünün platformda tanımlı olup olmadığını kontrol eder /api/coin-exists
- Coin sembolünden yerel olarak barındırılan simge yoluna eşleme /api/coin-icons
- Coin sayfası toplu özeti /api/content/coin
- Site geneli bölüm özeti /api/content/summary
- İtibari para döviz kuru tablosu /api/currency/fx
- Borsa kimliğinden yerel olarak barındırılan simge yoluna eşleme /api/exchange-icons
- Canlılık kontrolü /api/health
- Araştırma sayfası istatistikleri /api/research/stats