FACTSET Direct Streaming Of Transaction Messages API Software
Informace o produktu
Specifikace
- Název produktu: API pro přímé streamování transakčních zpráv
- Verze: 1.0
- Příručka pro vývojáře a referenční datum: srpen 2023
Motivace
Motivací rozhraní Direct Streaming of Transaction Messages API je poskytnout způsob, jak propojit záznamy od jakéhokoli poskytovatele OMS a integrovat obchodní data s platformou pro správu portfolia (PMP) společnosti FactSet v reálném čase pro dohled nad portfoliem, simulaci obchodu, připisování výkonu a analýzu výnosů. .
Program API
Nadview
Program API se zpočátku zaměřuje na nástroj pro analýzu portfolia a rozšířil se o další nástroje pro analýzu, produkty a rozhraní API z různých obchodních jednotek.
Program poskytuje následující:
- API pro přímé streamování transakčních zpráv
Všechna rozhraní API jsou hostována pod https://api.factset.com. Autentizace je řešena pomocí API klíčů a autorizace je řešena pomocí interního předplatitelského produktu FactSet. Další informace o používání klíčů API naleznete na adrese https://developer.factset.com/authentication.
Vezměte prosím na vědomí, že názvy hlaviček požadavků a odpovědí HTTP by se podle standardu HTTP neměly rozlišovat malá a velká písmena. Doporučuje se nespoléhat na shodu hlaviček ve vašem kódu s rozlišením velkých a malých písmen.
Návod k použití produktu
DSoTM API
Odeslání záznamů
- Chcete-li odeslat záznamy transakcí, použijte následující koncový bod:
- POST /analytics/dsotm/v1/transactions
Vyžádejte si záhlaví
- Povolení
Standardní HTTP hlavička. Hodnota musí být ve formátu „Basic“. - Typ obsahu
Standardní HTTP hlavička. Hodnota musí být specifikována jako aplikace/JSON, aby bylo zřejmé, že tělo je ve formátu JSON.
Odstraňování problémů
Informace o odstraňování problémů naleznete v části 4 Příručky a reference pro vývojáře.
Upgrade verze
Informace o upgradech verzí naleznete v části 5 Příručky a reference pro vývojáře.
FAQ
- Otázka: Jaký je účel rozhraní API pro přímé streamování transakčních zpráv?
Odpověď: Účelem rozhraní Direct Streaming of Transaction Messages API je propojit obchodní data od libovolného poskytovatele OMS s platformou pro správu portfolia společnosti FactSet pro dohled nad portfoliem, simulaci obchodu, připisování výkonu a analýzu výnosů. - Otázka: Kde najdu další informace o používání klíčů API?
Odpověď: Další informace o používání klíčů API naleznete na adrese https://developer.factset.com/authentication.
Motivace
V roce 1997 společnost FactSet spustila Portfolio Analysis 1.0, která položila základy pro Analytics. Brzy poté Portfolio Analysis 2.0 integrovala analýzu rizik od dodavatelů třetích stran a poté se v roce 2004 rozšířila o Fixed Income. FactSet nyní nabízí robustní sadu produktů pro analýzu portfolia s více aktivy, které vedou trh z hlediska flexibility, analýzy a šíře. Dnes se klienti spoléhají na FactSet pro interaktivní analýzy prostřednictvím různých produktů, jako je Portfolio Analysis (PA), SPAR, Alpha Testing, Optimizers a Portfolio Dashboard, stejně jako distribuce analýz prostřednictvím Portfolio Batcher, Publisher Flat. Files a dokumenty vydavatele.
Program API
Nadview
Klienti směřují k vytváření vlastního řešení, řízeni potřebou zvýšit produktivitu konsolidací informací do jediného uživatelského prostředí. Odhalením analýzy, výkonu a rizik prostřednictvím rozhraní API vám poskytuje sofistikovaný kanál pro interakci s předními analytickými nástroji společnosti FactSet pro více aktiv. Vzhledem k tomu, že trh nadále vyžaduje větší transparentnost a data, bude FactSet poskytovat flexibilní možnosti, jak tyto požadavky splnit. Rozhraní API doplňují současnou nabídku analytických sad a usnadňují partnerství tím, že vám umožňují budovat soukromá prostředí, integrovat se s nástroji BI třetích stran, jako je Tableau, a statistickými balíčky třetích stran, jako je RStudio, a zvýšit kontrolu nad interní spotřebou analytiky z FactSet.
První stage odhalení Analytics API se zaměří na nástroj pro analýzu portfolia. Od svého založení se program rozšířil o další analytické nástroje, produkty a rozhraní API z jiných obchodních jednotek.
Program poskytuje následující:
- Sada nástrojů pro vývojáře k vytvoření důkazu konceptu
- Jednotný dojem napříč všemi podnikovými rozhraními API FactSet
- Dodržování průmyslových standardů
- Verzí API
- Rozsáhlá dokumentace a návody na vývojářském portálu
API pro přímé streamování transakčních zpráv
- Propojte záznamy od libovolného poskytovatele OMS a integrujte svá obchodní data s platformou pro správu portfolia (PMP) společnosti FactSet v reálném čase pro dohled nad portfoliem a simulaci obchodu nebo pro použití ve výkonném Portfolio Analytics Engine pro analýzu výkonnosti a návratnosti.
- Všechna rozhraní API jsou hostována pod https://api.factset.com. Autentizace je řešena pomocí API klíčů a autorizace je řešena pomocí interního předplatitelského produktu FactSet. Více informací o používání API klíčů naleznete na https://developer.factset.com/authentication.
Názvy hlaviček požadavků HTTP a odpovědí by se podle standardu HTTP neměly rozlišovat malá a velká písmena. Nespoléhejte se prosím na porovnávání hlaviček v kódu, kde se rozlišují velká a malá písmena.
Odeslání záznamů
Odeslat transakce
POST /analytics/dsotm/v1/transactions
Tento koncový bod přijímá záznamy transakcí a současně je zapisuje do OMS_OFDB zadaného portfolia a zpřístupňuje je v aplikaci PMP.
Vyžádejte si záhlaví
| Název záhlaví | Popis |
| Povolení | Standardní HTTP hlavička. Hodnota musí používat 'Basic ' formát. |
| Obsah-Typ | Standardní HTTP hlavička. Hodnota musí specifikovat aplikaci/JSON (tj. volající musí specifikovat, že tělo je ve formátu JSON). |
Tělo žádosti
Tělo požadavku přijímá kolekci parametrů výpočtu. Parametry jsou uvedeny níže:
| Název parametru | Typ dat | Požadovaný | Popis | Formát |
| exekuce | Pole | Žádný | Seznam exekučních záznamů | Podrobná pole záznamů jsou k dispozici zde |
| umístění | Pole | Žádný | Seznam záznamů o umístění | Podrobná pole záznamů jsou k dispozici zde |
| objednávky | Pole | Žádný | Seznam záznamů zakázek | Podrobná pole záznamů jsou k dispozici zde |
Záhlaví odpovědí
| Název záhlaví | Popis |
| X-DataDirect-Request-Klíč | Záhlaví klíče požadavku FactSet. |
| X-FactSet-Api-Request-Key | Klíč k jedinečné identifikaci požadavku API Analytics. Dostupné pouze po úspěšné autentizaci. |
| X-FactSet-Api-RateLimit-Limit | Počet povolených požadavků pro časové okno. |
| X-FactSet-Api-RateLimit-Remaining | Počet zbývajících požadavků pro časové okno. |
| X-FactSet-Api-RateLimit-Reset | Počet sekund zbývajících do resetování limitu rychlosti. |
Návraty
| Stavový kód HTTP | Popis |
| 202 | Očekávaná reakce. |
| 400 | Neplatné tělo POST. |
| 401 | Chybějící nebo neplatné ověření. |
| 403 | Uživatel je zakázán s aktuálními přihlašovacími údaji. |
| 415 | Chybějící/neplatné záhlaví Content-Type. Hlavička musí být nastavena na application/json. |
| 429 | Bylo dosaženo limitu sazby. Zopakujte požadavky po čekání po dobu uvedenou v záhlaví retry-after. |
| 500 | Chyba serveru. Protokolujte hlavičku X-DataDirect-Request-Key, která vám pomůže při odstraňování problémů. |
| 503 | Vypršel časový limit žádosti. Zkuste požadavek za nějakou dobu znovu. |
Poznámky
Pro každé rozhraní API je povoleno maximálně 50 požadavků POST v 5sekundovém okně. Totéž lze ověřit pomocí různých hlaviček Rate-Limit dostupných v odpovědi API.
- X-FactSet-Api-RateLimit-Limit – Počet povolených požadavků pro časové okno.
- X-FactSet-Api-RateLimit-Remaining – Počet zbývajících požadavků pro časové okno.
- X-FactSet-Api-RateLimit-Reset – Počet sekund zbývajících do resetování limitu rychlosti.
Examples
Žádost:
ZVEŘEJNIT https://api.factset.com/analytics/dsotm/v1/transactions.
Záhlaví:
- typ obsahu: app/json
- Povolení: Základní RkRTX0RFTU9fVVMt***********************************
- Accept-Encoding: gzip
- délka obsahu: 201
Tělo:
Odpověď:
HTTP 202 přijato
Záhlaví:
- x-data direct-request-key: zpdo6aebv58fiaoi
- x-factset-api-request-key: 6p2d41m4sw1yfh0h
Záznamová pole
Vytvoření exekuce
| Živel | Typ | Popis | Povinné |
| portfolia | Řetězec | Název portfolia. Příklad: KLIENT:/DEMO.OFDB | ANO |
| ID transakce | Řetězec | Jedinečné ID pro transakci | ANO |
| symbol | Řetězec | Symbol odpovídající obchodovanému nástroji. Příklad: AAPL | ANO |
| popis | Řetězec | Obvykle název, např.: FACTSET RESEARCH SYSTEMS, ale pro deriváty může být popisnější. | ANO |
| typ obchodu | Řetězec | BL (Koupit Long), BC (Koupit do pokrytí), SL (Sell Long) a SS (Sell Short) | ANO |
| postavení | Řetězec | ACCT nebo CNCL, zkratka pro ACCOUNTED a CANCELED | ANO |
| datum obchodu | Řetězec | Datum obchodu ve formátu RRRRMMDD | ANO |
| transakce odejde | Plovák | Akcie, které byly objednány a nebyly provedeny | ŽÁDNÝ |
| množství | Plovák | Množství obchodovaného nástroje | ANO |
| síť | Plovák | Peněžní hodnota transakce bez nákladů na zprostředkování. | ANO |
| hrubý | Plovák | Hotovostní hodnota transakce včetně nákladů na zprostředkování. | ANO |
| vypořádací hodnotu | Plovák | Hotovostní hodnota transakce je hodnota, která byla vynásobena příslušným směnným kurzem, aby se transakce zaúčtovaná v místní měně převedla na měnu vykazování. | ANO |
| datum vypořádání | Řetězec | Datum vypořádání ve formátu RRRRMMDD | ANO |
| měna | Řetězec | Kód měny polí s peněžní hodnotou, Čistá částka a Hrubá částka. | ANO |
| směnný kurz | Plovák | Směnný kurz, který může PA vyzvednout, vynásobený polem s hotovostní hodnotou, Netto, Gross, aby PA mohl zobrazovat transakce ve vykazované měně. | ŽÁDNÝ |
| vypořádací měna iso | Řetězec | Kód měny pro hodnotu vypořádání | ANO |
| objednal | Řetězec | Jedinečný identifikátor Objednávky poskytuje PM Hub. Příklad: O_FDS_010623_1686393260254 | ŽÁDNÝ |
| parentId | Řetězec | Jedinečný identifikátor Rodičovské objednávky, který poskytne OMS. | ŽÁDNÝ |
Vytvoření objednávky
| Živel | Typ | Popis | Povinné |
| portfolia | Řetězec | Název portfolia. Příklad: KLIENT:/DEMO.OFDB | ANO |
| ID transakce | Řetězec | Jedinečné ID pro transakci | ANO |
| symbol | Řetězec | Symbol odpovídající obchodovanému nástroji. Příklad: AAPL | ANO |
| popis | Řetězec | Obvykle název, např.: FACTSET RESEARCH SYSTEMS, ale pro deriváty může být popisnější. | ANO |
| typ obchodu | Řetězec | BL (Koupit Long), BC (Koupit do pokrytí), SL (Sell Long) a SS (Sell Short) | ANO |
| postavení | Řetězec | ACCT nebo CNCL, zkratka pro ACCOUNTED a CANCELED | ANO |
| datum obchodu | Řetězec | Datum obchodu ve formátu RRRRMMDD | ANO |
| transakční listy | Plovák | Akcie, které byly objednány, ale nebyly provedeny | ŽÁDNÝ |
| množství | Plovák | Množství obchodovaného nástroje | ANO |
| měna iso | Řetězec | Kód měny polí s peněžní hodnotou, Čistá částka a Hrubá částka. | ANO |
| směnný kurz | Plovák | Směnný kurz, který může PA vyzvednout, vynásobený polem s hotovostní hodnotou, Netto, Gross, aby PA mohl zobrazovat transakce ve vykazované měně. | ŽÁDNÝ |
| číslo objednávky | Řetězec | Jedinečný identifikátor Objednávky poskytuje PM Hub. Příklad: O_FDS_010623_1686393260254 | ŽÁDNÝ |
Vytvoření umístění
| Živel | Typ | Popis | Povinné |
| portfolia | Řetězec | Název portfolia. Příklad: KLIENT:/DEMO.OFDB | ANO |
| ID transakce | Řetězec | Jedinečné ID pro transakci | ANO |
| symbol | Řetězec | Symbol odpovídající obchodovanému nástroji. Příklad: AAPL | ANO |
| popis | Řetězec | Obvykle název, např.: FACTSET RESEARCH SYSTEMS, ale pro deriváty může být popisnější. | ANO |
| typ obchodu | Řetězec | BL (Koupit Long), BC (Koupit do pokrytí), SL (Sell Long) a SS (Sell Short) | ANO |
| postavení | Řetězec | ACCT nebo CNCL, zkratka pro ACCOUNTED a CANCELED | ANO |
| datum obchodu | Řetězec | Datum obchodu ve formátu RRRRMMDD | ANO |
| transakční listy | Plovák | Akcie, které byly objednány, ale nebyly provedeny | ŽÁDNÝ |
| množství | Plovák | Množství obchodovaného nástroje | ANO |
| měna iso | Řetězec | Kód měny polí s peněžní hodnotou, Čistá částka a Hrubá částka. | ANO |
| směnný kurz | Plovák | Směnný kurz, který může PA vyzvednout, vynásobený polem s hotovostní hodnotou, Netto, Gross, aby PA mohl zobrazovat transakce ve vykazované měně. | ŽÁDNÝ |
| vypořádací měna iso | Řetězec | Kód měny pro hodnotu vypořádání | ANO |
| číslo objednávky | Řetězec | Jedinečný identifikátor Objednávky poskytuje PM Hub. Příklad: O_FDS_010623_1686393260254 | ŽÁDNÝ |
| ID rodiče | Řetězec | Jedinečný identifikátor Rodičovské objednávky, který poskytne OMS. | ŽÁDNÝ |
Odstraňování problémů
Následující kroky se doporučují k odstraňování chyb z kteréhokoli z různých rozhraní API:
- Zaznamenejte si hlavičku odpovědi X-DataDirect-Request-Key, aby technický tým FactSet API mohl analyzovat váš konkrétní požadavek/odpověď.
- Pokud je odpovědí chybová odpověď, zaznamenejte si tělo odpovědi. Všechny stavové kódy HTTP rovné a větší než 400 jsou považovány za chybové odpovědi.
- Požádejte o pomoc svůj tým spravující účty s výše uvedenými informacemi.
Upgrade verze
- FactSet bude po omezenou dobu podporovat staré verze API. Skutečná doba podpory bude záviset na API a verzíchtage (tj. beta nebo produkce). Všechny změny, doplňky funkcí a opravy chyb v předchozích verzích budou zdokumentovány v protokolu změn.
- Tým inženýrů API společnosti FactSet bude spolupracovat s klienty na zajištění hladkého přechodu na novější verze.
Copyright © 2023 FactSet Research Systems Inc. Všechna práva vyhrazena.
FactSet Research Systems Inc. | www.factset.com.
Dokumenty / zdroje
 |
FACTSET Direct Streaming Of Transaction Messages API Software [pdfUživatelská příručka Verze 1.0, Direct Streaming Of Transaction Messages API Software, Streaming Of Transaction Messages API Software, Transaction Messages API Software, Messages API Software, API Software, Software |