Hızlı başlangıç
PortGate, Portfoy veri platformu üzerinde bir piyasa verisi API'sidir: BIST hisseleri, ABD hisseleri ve ETF'leri, Türk yatırım fonları, döviz, emtia, dünya endeksleri ve sektör analitiği — REST + WebSocket, tek anahtar.
Temel URL
https://api.theportfoy.com/portgateTüm REST uç noktaları /v1 altında yer alır. Etkileşimli OpenAPI referansı: /portgate/docs.
İlk isteğiniz
API anahtarınızla X-API-Key başlığında kimlik doğrulaması yapın (geliştirici portalında oluşturulur, biçim pg_live_…):
curl -H "X-API-Key: $PORTGATE_KEY" \
"https://api.theportfoy.com/portgate/v1/quotes/bist:THYAO"{
"instrument_id": "bist:THYAO",
"symbol": "THYAO",
"market": "bist",
"currency": "TRY",
"last": "338.25",
"prev_close": "334.50",
"change_pct": "1.1211",
"open": "338", "high": "341.25", "low": "336.75",
"volume": "48757580", "turnover": "16543210987.50",
"limit_up": "378.75", "limit_down": "310.25",
"as_of": "2026-07-10T15:19:01Z",
"data_delay_seconds": 900
}Enstrüman kimlikleri
Her enstrüman {market}:{SYMBOL} olarak adreslenir — küçük harf piyasa ad alanı, büyük harf sembol:
bist:THYAO BIST equity
bist:ZPX30F BIST ETF / BYF (same quotes + candles as equities)
us:AAPL US stock / ETF (us:SPY)
fund:AFA Turkish mutual fund
fx:USDTRY FX pair (65 pairs, e.g. fx:GBPJPY)
cmdty:GLD Commodity (gold spot; cmdty:BRENT, cmdty:CEYREK)
index:FTSE World index (index:SPX500, index:N225)
crypto:1 Crypto coin in USD (crypto:BTC works when unique)Nelerin var olduğunu GET /v1/instruments ile keşfedin — bkz. Enstrümanlar ve piyasalar.
Kaynağa sadık veri
null olur ve uç nokta belgeleri nedenini açıklar. as_of her zaman fiyatın gözlem zamanıdır, bizim yazma zamanımız değil; ve her kotasyon kendi data_delay_seconds durumunu taşır.Hatalar
Her yerde tek bir hata biçimi (RFC-7807 tarzı), destek için bir istek kimliğiyle:
{
"title": "Forbidden",
"status": 403,
"detail": "key lacks scope 'history'",
"instance": "/v1/candles/bist:THYAO",
"request_id": "0f3c…"
}Tam durum kodu referansı, 429 hız limiti sözleşmesi ve yeniden deneme rehberi: Hatalar ve hız limitleri.
Sonraki adımlar
- Kimlik doğrulama, kapsamlar ve hız limitleri — anahtarınızın neler yapabileceği.
- WebSocket hızlı başlangıcı — canlı kotasyon akışı.
- Piyasa bazlı rehberler: BIST, ABD, fonlar, döviz, emtia, dünya endeksleri, logolar, sektörler (sol menü).
- Adil kullanım — test programı koşulları (lütfen geliştirmeye başlamadan önce okuyun).
