OpenAPI belgesi
Herkese açık API'nin OpenAPI 3.0 tanımı; katalogdan ve gerçek yanıtlardan çıkarılan alan tablolarından üretilir.
/api/meta/openapiİstek
Bu uç nokta parametre almaz.
Örnek istek
curl -s "https://www.coinboss.com/api/meta/openapi"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 |
|---|---|---|---|
| openapi | string | — | Bu belgenin OpenAPI belirtim sürümü. |
| info | object | — | API'nin başlığı, sürümü ve açıklaması. |
| info.title | string | — | API başlığı. |
| info.version | string | — | API sürümü. |
| info.description | string | — | API'nin ve kurallarının kısa açıklaması. |
| servers | array | — | API'nin temel URL'leri. |
| servers[] | object | — | Tek bir sunucu kaydı. |
| servers[].url | string | — | Her yolun başına eklenecek temel URL. |
| tags | array | — | Uç nokta kategorileri. |
| tags[] | object | — | Tek bir kategori. |
| tags[].name | string | — | Ad. |
| tags[].description | string | — | Kategorinin açıklaması. |
| paths | object | — | Uç noktalar; yola göre anahtarlanır. dinamik anahtarlar: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list |
| paths.{*} | object | — | Tek bir yolda kullanılabilen işlemler. |
| paths.{*}.get | object | — | GET işlemi. |
| paths.{*}.get.operationId | string | — | Uç nokta kimliği; katalogdakiyle aynı kimlik. |
| paths.{*}.get.summary | string | — | Özet bloğu. |
| paths.{*}.get.description | string | — | Uç noktanın ne döndürdüğü; kapsam ve sınırlara ilişkin notlarla birlikte. |
| paths.{*}.get.tags | array | — | Uç noktanın kategorileri. |
| paths.{*}.get.tags[] | string | — | Kategori kimliği. |
| paths.{*}.get.x-declared-status | string | — | Beyan edilen kullanılabilirlik: `available`, `partial` veya `unavailable`. |
| paths.{*}.get.x-cache-ttl-seconds | number | s | Uç noktanın sunucu tarafı önbellek ömrü. bulunmayabilir |
| paths.{*}.get.parameters | array | — | İstek parametreleri. bu tabloyu üretmek için kullanılan örneklerde boş |
| paths.{*}.get.parameters[] | object | — | Tek bir parametre. |
| paths.{*}.get.parameters[].name | string | — | Ad. |
| paths.{*}.get.parameters[].in | string | — | Parametrenin yer aldığı konum: `query` veya `path`. |
| paths.{*}.get.parameters[].required | boolean | — | Parametrenin gönderilmesi zorunluysa `true`. |
| paths.{*}.get.parameters[].description | string | — | Parametrenin anlamı. |
| paths.{*}.get.parameters[].schema | object | — | Parametre değerinin JSON Schema'sı (tür, varsayılan, enum, minimum, maksimum). |
| paths.{*}.get.parameters[].example | string | — | Örnek değer. bulunmayabilir |
| paths.{*}.get.responses | object | — | HTTP durumuna göre anahtarlanan yanıtlar; 200 yanıtı, gerçek yanıtlardan üretilen JSON Schema'yı taşır. |
| components | object | — | Her uç noktanın kullandığı hata gövdesi dahil, paylaşılan şemalar. |
Üretilme zamanı: 2026-11-11 23:03 UTC; kaynak: 1 gerçek yanıt.
Örnek yanıt
/api/meta/openapi · 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: tags: 21 öğe içeriyordu; paths: 298 öğe içeriyordu; paths.{*}.get.responses: 5 öğe içeriyordu; paths.{*}.get.parameters: 3 öğe içeriyordu; components.schemas.Error.properties.code.enum: 9 öğe içeriyordu.
- "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"
- "tags"
- "paths"
- "/api/coin-heatmap"
- "/api/coins/all"
- "components"
- "schemas"
- "securitySchemes"
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
- 5m
- Edge mikro önbelleği
- 10s
- 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ı: %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ı →
| 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/openapiKullanılabilirParametre yok.
https://www.coinboss.com/api/meta/openapiBu 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