Kimlik doğrulama, kapsamlar ve limitler
API anahtarları, kapsam modeli, hız sınırlama ve ölçümleme.
API anahtarları
Anahtarlar geliştirici portalında oluşturulur ve her istekte bir başlık olarak gönderilir. Anahtarlar oluşturulurken yalnızca bir kez gösterilir ve hash'lenerek saklanır — onlara parola gibi davranın.
X-API-Key: pg_live_XXXXXXXXXXXXXXXXXXXXXXXXAuthorization: Bearer pg_live_… eşdeğer bir alternatif olarak kabul edilir — HTTP istemciniz hangisini kolaylaştırıyorsa onu kullanın.
Kapsamlar
Her anahtar bir dizi kapsam taşır (oluşturulurken seçilir, planınızla sınırlıdır):
| Alan | Tür | Notlar |
|---|---|---|
| quotes:bist | scope | BIST kotasyonları, enstrümanlar, piyasa durumu/hareket edenler, sektör anlık durumu + üyeleri, halka arzlar |
| quotes:fund | scope | Fon kotasyonları (NAV) + fon profilleri |
| quotes:us | scope | ABD kotasyonları + şirket/ETF profilleri |
| history | scope | Mumlar, EOD, NAV geçmişi, göstergeler, finansal tablolar, değerleme, fon performansı, temettüler, sektör serileri, dönem istatistikleri |
| funds:analytics | scope | Fon portföyleri, akışlar, sahip-olanlar, trend |
| live | scope | WebSocket akışı |
| fx | scope | Döviz paritesi kotasyonları (ayrıca ?currency= dönüşümünü de besler) |
| news:bist | scope | BIST piyasa haberleri — başlıklar + yapay zeka özeti/duyarlılığı |
| news:us | scope | ABD piyasa haberleri — başlıklar + yapay zeka özeti/duyarlılığı |
| kap | scope | KAP kurumsal bildirimleri (ham + yapay zeka işlenmiş) |
| assets:logos | scope | Enstrüman logosu PNG'leri (ETag/304 önbellekli, eksikte dürüst 404) |
| quotes:cmdty | scope | Emtia kotasyonları — sembol başına para birimi, birim ve kategori |
| quotes:index | scope | Dünya endeksi kotasyonları — sembol başına kaynak etiketi (endeks seviyesi / CFD) |
| calendar:read | scope | Ekonomik takvim — actual/forecast/previous değerleriyle küresel makro olaylar |
| quotes:crypto | scope | Kripto kotasyonları — USD cinsinden ~800 coin, 7/24, piyasa değeriyle. Bu kapsam yayına girmeden önce oluşturulan anahtarlara otomatik eklenmez: yenileme (rotate) eski kapsamları korur, bu yüzden yeni bir anahtar oluşturup işaretleyin |
| ipo:read | scope | Fiyat erişimi olmadan BIST halka arz listesi ve ayrıntısı (/v1/ipo). quotes:bist kapsamlı anahtarlar /v1/ipo'yu zaten çağırabilir ve ek olarak last_price ile return_since_ipo_pct alır; yalnızca ipo:read ile bu iki alan null gelir |
Anahtarınızın kapsamları dışındaki bir istek 403 döndürür ve eksik kapsam detail içinde belirtilir.
Hız limitleri
Anahtar başına token-bucket: ani yük payı olan sürekli bir hız (test planı: sürekli 10 istek/sn, ani yük 20). Her yanıt şunları taşır:
X-RateLimit-Limit: 20
X-RateLimit-Remaining: 14Limite ulaşmak 429 döndürür — geri çekilin ve yeniden deneyin. Sürekli aşım engellenmez, yalnızca kısıtlanır.
Kullanım ölçümleme
Çoğu istek 1 birim olarak ölçülür. Aralıklı okumalar (mumlar, EOD, sektör serileri) ve tam katalog enstrüman çekmeleri boyuta göre ölçülür: başlanan her 100 satır için 1 birim. Kullanımınız portal panosunda görünür.
