Geliştirici API'si

fom_live_… anahtarınızı Bearer token olarak gönderin: /api/v1/meta anahtarı doğrular, /api/v1/screener sıralanmış tarayıcı sonuçlarını JSON olarak döndürür; her yanıtta hız sınırı başlıkları bulunur.

Formion Data API, uygulamada gördüğünüz sinyallere — sıralanmış tarayıcı sonuçları, kalibre edilmiş kazanma olasılıkları ve daha fazlası — kimlik doğrulamalı basit bir REST uç noktası üzerinden programatik erişim sağlar. Formion’ın avantajını kendi sistemlerinde kullanmak isteyen nicel analistler, bot geliştiricileri ve işlem masaları için tasarlanmıştır.

Durum: talep üzerine kullanılabilir. Anahtarlar Formion ekibi tarafından manuel olarak verilir. Kullanıcıların kendi kişisel API tokenlerini oluşturabilmesi yol haritasında — Profil → Lisans bölümündeki API erişim kartında Yakında yazar. Anahtar talep etmek için [email protected] ile iletişime geçin.

Kimlik doğrulama

Her istek, API anahtarınızı bearer token olarak taşır:

curl "https://app.formion.ai/api/v1/screener?tf=1d&limit=25" \
  -H "Authorization: Bearer fom_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

• Anahtarlar fom_live_… biçimindedir. Onları parola gibi koruyun — anahtara sahip herkes API’yi sizin adınıza çağırabilir.
• Anahtar verildiğinde bir kez gösterilir ve tarafımızda yalnızca hash olarak saklanır. Kaybederseniz iptal edip yenisini veririz — geri getiremeyiz.
• Hızlı test için anahtarı ?api_key=… olarak da iletebilirsiniz, ancak Authorization başlığı tercih edilir.

Anahtarınız eksik, yanlış veya iptal edilmişse şu yanıtı alırsınız:

{ "ok": false, "error": "unauthorized", "hint": "Send a valid key as 'Authorization: Bearer fom_live_…'. Request access at [email protected]." }

HTTP 401 durum koduyla.

Hız sınırları

Her anahtarın, API katmanına göre belirlenen dakikalık bir istek kotası vardır (anahtar verilirken atanır):

Katman	İstek / dakika
Ücretsiz	60
Pro	600
Institutional	6 000

İstek hızınızı kendiniz ayarlayabilmeniz için her yanıtta standart başlıklar bulunur:

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 594
X-RateLimit-Reset: 1789200000     # unix seconds when the window resets

Kota aşıldığında HTTP 429 ile birlikte { "ok": false, "error": "rate_limited", "tier": "…" } ve Retry-After başlığı (saniye) döndürülür. Bekleyip yeniden deneyin.

Sürümleme

Tüm uç noktalar /api/v1/ altında yer alır. v1 yanıt yapısını sabit bir sözleşme olarak ele alıyoruz — yeni alanlar eklenebilir, ancak mevcut alanların anlamı yeni bir sürüm (/api/v2/) olmadan değişmez veya alanlar kaldırılmaz. v1 ile güvenle geliştirin.

---

Uç noktalar

GET /api/v1/meta`

Anahtarınızın çalıştığını doğrular ve erişebildiği uç noktaları listeler.

curl https://app.formion.ai/api/v1/meta -H "Authorization: Bearer fom_live_…"

{
  "ok": true,
  "api_version": "v1",
  "key": { "tier": "pro", "rate_per_min": 600, "label": "Acme backtest bot" },
  "endpoints": [
    { "path": "/api/v1/meta", "method": "GET", "desc": "This key's tier + endpoint list." },
    { "path": "/api/v1/screener", "method": "GET", "desc": "Ranked multi-market screener with Formion score + P(win). Query: tf, limit, minScore." }
  ],
  "docs": "https://docs.formion.ai/api",
  "support": "[email protected]"
}

GET /api/v1/screener`

Sıralanmış çoklu piyasa tarayıcısı — uygulamanın Screener sekmesini çalıştıran motorun aynısı.

Sorgu parametreleri

Parametre	Varsayılan	Açıklama
tf	1d	Zaman dilimi: 5m, 15m, 1h, 4h, 1d
limit	100	Döndürülecek satır sayısı (en fazla 500)
minScore	0	Yalnızca skoru ≥ bu değer olan satırları döndürür

Örnek

curl "https://app.formion.ai/api/v1/screener?tf=4h&limit=5&minScore=60" \
  -H "Authorization: Bearer fom_live_…"

{
  "ok": true,
  "api_version": "v1",
  "tier": "pro",
  "timeframe": "4h",
  "scanned_at": 1789199400000,
  "count": 5,
  "data": [
    {
      "symbol": "SOLUSDT",
      "asset_class": "crypto",
      "category": "bull-pullback",
      "direction": "long",
      "score": 74,
      "win_probability": 0.58,
      "rsi_1d": 61,
      "tags": ["at-bull-fvg", "bos-up-1d", "arsi-turn-up-4h"]
    }
  ]
}

Alan açıklamaları

Alan	Anlamı
symbol	Borsa işlem çifti veya sembol
asset_class	Satırın varlık sınıfı (örneğin crypto, stock, index, commodity)
category	İşlem kurulumu sınıfı (bull, bear-rally, sweep-confirmed, …)
direction	long, short veya null
score	Bileşik Formion skoru, 0–100
win_probability	Sinyalin ilgili zaman diliminin sonunda doğru çıkmasına ilişkin kalibre edilmiş model olasılığı veya model doğruluk eşiğini geçmediyse null
rsi_1d	Günlük RSI(14)
tags	Yapı + momentum etiketleri (FVG, BoS/CHoCH, VWAP, Adaptive-RSI dönüşleri, …)
scanned_at	İlgili taramanın Unix ms cinsinden zamanı (veriler birkaç dakika eski olabilir)

Bu iki uç nokta (/meta ve /screener), şu anki v1 API’nin tamamını oluşturur. Başka verilere ihtiyacınız varsa hangileri olduğunu bize bildirin — henüz ek uç noktalar için bir taahhüt yoktur.

---

Sorumlu kullanım

• Önbelleği ve sorgulama sıklığını akıllıca yönetin. Tarayıcı birkaç dakikada bir yeniden tarama yapar; daha sık sorgulamak aynı veriler için istek kotanızı tüketir. scanned_at değerini okuyun ve değişmediyse sorguyu atlayın.
• Her sistem için bir anahtar kullanın. Aynı anahtarı farklı istemciler arasında paylaşmayın — anahtar bazında ölçüm, hem bizim hem de sizin kullanımı takip etmemizi sağlar.
• Anahtarı asla tarayıcıya veya herkese açık bir repoya göndermeyin. Anahtar sızarsa iptal edip yenisini verebilmemiz için bize e-posta gönderin.

Anahtar alma

Kullanım amacınızı ve beklenen istek hacmini [email protected] adresine e-postayla iletin. Bir anahtar verecek, kullanım kademesini belirleyecek ve ilk API çağrınızı çalıştırmanıza yardımcı olacağız.