API kuralları

Tüm uç noktalarda geçerli kurallar: URL düzeni, yanıt zarfı, semboller, birimler, zaman damgaları, sayfalama ve önbellekleme.

Temel URL ve sürümleme

Tüm uç noktalar tek bir temel URL altında yer alır ve HTTPS GET ile çağrılır. Mevcut yollar v1 sürümüdür. v1 içinde değişiklikler yalnızca ekleme niteliğindedir: yeni alanlar ve uç noktalar eklenebilir; mevcut alanlar adını, türünü ve anlamını korur. Uyumluluğu bozan bir değişiklik yeni bir yol altında yayımlanır ve önce değişiklik günlüğünde duyurulur.

Temel URLhttps://www.coinboss.com/api

Yanıt zarfı

Her JSON yanıtında en üst düzeyde bir success bayrağı bulunur. CoinBoss'un kendi topladığı veri katmanının uç noktaları (/api/sd altındaki yollar) şu ek blokları da ortak olarak içerir:

Alan	Açıklama
success	Çağrı başarılıysa true. Her zaman kontrol edin.
schema	Yanıt yapısının tanımlayıcısı ve ana sürümü.
now	Yanıtın oluşturulduğu andaki sunucu zamanı, milisaniye cinsinden.
coverage	Hangi borsaların dahil olduğu, hangilerinin neden mevcut olmadığı ve hangilerinin eskimiş olduğu için hariç tutulduğu.
method	Yanıttaki her toplu değerin ardındaki formül veya kural.
meta	Kaynaklar, zaman damgaları, pencere, kalite derecesi, eskime bayrağı, önbellek ömrü ve yedek (fallback) davranışı.

Eski uç noktalar success ile birlikte bir data alanı döndürür; coverage, method veya meta içermeyebilir. Kesin alanlar referans sayfalarında belgelenmiştir.

Coinler, sözleşmeler ve borsalar

coin parametreleri büyük harfli temel coin sembolünü alır; örneğin BTC veya PEPE.
1000PEPE veya kPEPE gibi çarpanlı sözleşmeler, miktarları dönüştürülerek temel coinleriyle birleştirilir.
Borsa tanımlayıcıları küçük harflidir; örneğin binance, okx, bybit, hyperliquid.
Sözleşme sembolleri borsanın adlandırdığı biçimde döndürülür. Bir uç nokta bunları bir arada döndürüyorsa USDT, USDC ve coin teminatlı sözleşmeler ile teslimatlı vadeli sözleşmeler bir sözleşme türü alanıyla ayırt edilir.
Bir kripto varlıkla aynı ticker'ı paylaşan tokenize hisse ve emtia sürekli vadeli sözleşmeleri kripto toplamlarına dahil edilmez.

Birimler

_usd ile biten alanlar ABD doları cinsinden nominal değerdir.
Fonlama oranları yüzde değil, ondalık kesirdir: 0.0001 değeri %0,01 demektir. _8h ile biten alanlar 8 saatlik aralığa normalize edilmiştir; özgün aralık ham oranın yanında döndürülür.
_pct ile biten alanlar yüzdedir: 1.5 değeri %1,5 demektir.
Açık pozisyon, alan açıklamasında aksi belirtilmedikçe USD cinsinden tek taraflı nominal değerdir. Çift taraflı rakam yayımlayan borsalar method bloğunda belirtilir.
Bazı eski uç noktalar hassasiyeti korumak için ondalık sayıları dize olarak döndürür. Alan tablosu bu türü string(decimal) olarak gösterir.

Zaman damgaları

Zaman damgaları, alan açıklamasında aksi belirtilmedikçe UTC'ye göre milisaniye cinsinden Unix epoch değeridir.
observed_at, dahil edilen en yeni kayıt için borsanın kendi zaman damgasıdır; borsa sağlamıyorsa null olur.
received_at, CoinBoss toplayıcısının o kaydı sakladığı andır.
fetched_at, yanıtın oluşturulduğu andır. Önbellekten gelen bir yanıtta, çağrınızın zamanından en fazla önbellek TTL'si kadar eski olabilir.
Günlük seriler UTC gün sınırlarını kullanır.

Pencereler ve aralıklar

Pencere parametreleri kısa belirteçler kullanır: 1h, 4h, 12h, 24h ve bazı uç noktalarda 3d, 7d, 30d, 90d. Her uç noktanın kabul ettiği değerler referans sayfasında listelenir.
Bilinmeyen bir pencere değeri, parametre bazında belirtildiği üzere ya INVALID_PARAM ile reddedilir ya da belgelenen varsayılana döner.
Zaman serilerinde dilim boyutu pencereye bağlıdır ve referans sayfasında belirtilir.

Sayfalama ve sıralama

Liste uç noktaları, uç nokta bazında belgelendiği üzere limit ve offset ya da page ve size kullanır. Limitlerin bir üst sınırı vardır; daha büyük bir değer üst sınıra indirilir.
Yanıtta total varsa bu, sayfalamadan önceki satır sayısıdır.
Uç nokta bir sıralama parametresi belgelemediği sürece sıralama düzeni sabittir.

null, sıfır ve eksik alan

null, değerin bilinmediği ya da mevcut olmadığı anlamına gelir. 0 ise ölçülmüş bir sıfırdır.
Grafikler null için boşluk göstermelidir. Enterpolasyon yapmayın.
Alan tablosunda “bulunmayabilir” olarak işaretlenen bir alan nesnede hiç yer almayabilir; null gibi ele alın.

Önbellekleme

Her uç noktanın bir sunucu önbelleği TTL'si vardır; referans sayfasında ve meta.cache_ttl_s alanında gösterilir. X-Cache başlığı HIT, STALE veya MISS bildirir.
Çoğu GET uç noktasının önünde yaklaşık on saniyelik kısa bir edge önbelleği bulunur.
TTL'den daha sık sorgulamak aynı veriyi döndürür ve yalnızca istek sınırınızı tüketir.

WebSocket

WebSocketwss://www.coinboss.com/ws

Akış yalnızca sunucudan gönderilen (push-only) JSON mesajlarından oluşur. Her mesajda bir type alanı bulunur.
Bağlantı koptuktan sonra gecikmeli olarak yeniden bağlanın ve eksik veriyi ilgili HTTP uç noktasından tamamlayın.

Makinece okunabilir dokümantasyon

Katalog, her uç noktanın parametreleri ve alan tablosu, durum ve kalite matrisi /api/meta altında JSON olarak, kataloğun tamamı ise OpenAPI 3 belgesi olarak sunulur.