Programari FACTSET ID Lookup API
Preguntes freqüents
- P: Quin és el mètode d'autenticació per a l'API FactSet ID Lookup?
- R: L'API s'autentica mitjançant claus de l'API. Es pot trobar un procés d'autenticació detallat a la guia proporcionada.
- P: Quines són les funcionalitats bàsiques de l'API FactSet ID Lookup?
- R: L'API aprofita la funcionalitat de cerca de FactSet per retornar tickers, noms d'empresa i identificadors únics. També ofereix una funcionalitat d'avanç per obtenir resultats ràpids i una fàcil integració web aplicacions.
- P: Quina és la lògica de com es classifiquen els resultats?
- La classificació es basa en diverses variables. En general, la concordança de cadenes afecta la classificació en funció de com coincideix el terme de cerca amb els resultats. A més, cada tipus d'entitat té les seves pròpies variables úniques que poden afectar la classificació. Per exampLes accions utilitzen capitalització de mercat i cotització primària.
INFORMACIÓ DEL PRODUCTE
Organització de documents i audiència
Aquest document descriu com utilitzar l'API FactSet ID Lookup. Hauríeu d'estar familiaritzat amb JSON, API i Web Serveis. Aquest document descriu la sintaxi necessària per al format adequat de la sol·licitud, així com les regles per processar les respostes.
Marques comercials
FactSet és una marca comercial registrada de FactSet Research Systems, Inc. Tots els altres noms de marques o productes poden ser marques comercials de les seves respectives empreses.
Acabatview
Introducció a l'API FactSet ID Lookup
L'API FactSet Identifier Lookup exposa el servei que impulsa la funcionalitat de cerca a FactSet WorkStation i FactSet Web. Els clients poden aprofitar aquesta API per a la seva funcionalitat de cerca per retornar tickers, noms d'entitats i altres identificadors que admet FactSet.
Sampel Flux de dades
Funcionalitat bàsica i avantatges
- Aprofita la potent funcionalitat de cerca de FactSet per retornar tickers, noms d'empresa i identificadors únics per a les dades de FactSet
- Funcionalitat d'escriviu endavant per mostrar els resultats relacionats ràpidament
- Integració senzilla amb el vostre existent web aplicacions
Autenticació
- L'API s'autentica mitjançant claus API.
- El client rebrà un inici de sessió FactSet al portal del desenvolupador (https://developer.factset.com/).
- L'usuari final ha de generar una clau API des del portal del desenvolupador.
- La clau es genera una vegada i no es pot recuperar de nou. L'usuari ha de fer una còpia i emmagatzemar la clau de l'API.
- La guia completa del procés d'autenticació al servei es pot trobar aquí:
Certificats i cadenes de certificats
FactSet desaconsella molt la dependència de codificació en qualsevol certificat o cadena de certificats anunciada en les aplicacions. FactSet espera que els clients confiïn en la verificació de la infraestructura de clau pública i la validesa dels certificats:
- Els certificats de FactSet canviaran amb el temps a mesura que es renoven i la complexitat dels algorismes emprats augmenta (és a dir, les signatures SHA-2 en lloc de SHA-1). Aquesta és l'evolució constant de la seguretat a mesura que es retiren els antics algorismes de seguretat i s'inclouen nous algorismes de seguretat. Sovint, aquests certificats s'actualitzen durant diversos anys. La validació d'un certificat de forma dinàmica durant la connexió TLS l'ha d'incorporar el client com a pràctica necessària.
- Les cadenes de certificats de FactSet, incloses les autoritats de certificació intermèdies, poden canviar amb el temps, i és important que els clients validin dinàmicament els certificats de FactSet amb un magatzem de certificats arrel de confiança de CA modern. El certificat arrel actual de FactSet és Thawte arrel primària CA.
Protocols de seguretat
Els clients no haurien de codificar les dependències de cap protocol de seguretat específic, ja que FactSet es reactiva contínuamentviewestablint polítiques de seguretat i es reserva el dret de desactivar el suport per a protocols de seguretat antics amb un breu avís. Els protocols admesos actuals són TLSv1.1 i TLSv1.2, però en una data futura, aquests es poden substituir per versions futures. Els clients s'han d'assegurar que el seu programari pot gestionar els protocols de seguretat en constant canvi.
Límits de sol·licitud
Hi ha un límit en quantes sol·licituds pot fer cada client dins de durades específiques. Això és per garantir que l'API funcioni de manera òptima i mitigar qualsevol impacte en altres serveis de FactSet. L'API ofereix tres nivells de límits de sol·licitud. Tots els clients que utilitzin aquesta API obtindran el nivell predeterminat. Els clients que estiguin interessats en el nivell B haurien de parlar dels anuncis amb el seu representant de vendes de FactSet.
| Nivell | # de sol·licituds/s | # de peticions/minut | # de sol·licituds/hora |
| Per defecte | 20 | 100 | 2,000 |
| Nivell B | 200 | 1,000 | 20,000 |
Sample Escenaris
Depenent del nivell, l'API respondria amb un codi 429 en funció del límit de temps que arribin primer. El límit comença en el moment en què es fa la primera sol·licitud. El temps de la memòria cau es restabliria després d'una hora, fins i tot si el client no arriba al límit.
- [Client A: nivell predeterminat] A les 15:22:15, el client arriba al límit de 100 sol·licituds per minut. L'API respondria amb un 429 a les sol·licituds posteriors fins que s'aixequi la restricció un minut més tard a les 15:23:15
- Si el mateix client arriba al límit de 2,000 sol·licituds per hora a les 15:44:00, el límit no s'aixecarà fins a les 16:44:00.
API
L'API FactSet ID Lookup acceptarà sol·licituds POST en un cos de sol·licitud amb format JSON.
URL
- FactSet proporciona un entorn de producció que es pot utilitzar per accedir a la producció. La taula següent mostra el URL necessàries per a cada sistema.
| Tipus | Nom de l'amfitrió | Servei | Example URL1 |
| Producció | api.factset.com | idsearch | https://api.factset.com/idsearch/v1/idsearch |
Consulta
La consulta és una matriu que conté objectes de consulta de cerca amb paràmetres per executar-se simultàniament. Aquesta és la sol·licitud enviada a través de l'API per buscar un conjunt específic d'identificadors.
Consulta
L'objecte de consulta conté el terme de cerca i els filtres definits per l'usuari final. Cada objecte de consulta conté les parts següents:
| Noms | Descripció | Examples i Notes |
| patrons | Aquesta és la cadena o paraula clau en què s'està cercant. Cerques concurrents de diversos patrons
is NO recolzat |
Sistemes de recerca FactSet es tracta com un sol terme de cerca però no com FactSet O
Sistemes de recerca OR |
| entitats | La classe d'actius que s'està buscant | La llista de classes d'actius disponibles està disponible a Secció 2.2.4 |
| filtres | Ajuda a reduir els resultats de la cerca mitjançant la inclusió i/o l'exclusió de paràmetres.
Els filtres són específics segons a la classe d'actius |
La llista de filtres disponibles es mostra a Secció 2.2.4 |
| camps_de_cerca | Limiteu els resultats a aquests tipus de simbologia:
• Símbol • Nom de l'entitat • CUSIP |
Aquest paràmetre només està disponible per a aquestes classes d'actius:
• Renta variable • Empreses privades • Bons • ETF • Futurs • Fons d'inversió |
Filtres
L'objecte filtre (si s'utilitza) ha de contenir un dels elements següents o tots dos:
1 L'example URLs demostrar els diferents serveis assignats a producció i beta. El URLLes dades anteriors poden no ser vàlides. Per example, falta la cadena de consulta a l'example.
- Inclou: especifica criteris per incloure de manera selectiva conjunts de dades específics als resultats. Cada conjunt de dades té els seus propis camps rellevants, com ara equityType, isPrimary, region, etc. Per a cada camp, proporcioneu una matriu de valors que voleu filtrar. Per example, especificant [“EUA”, “GB”] per al camp de regió inclourà documents on la regió sigui els Estats Units o la Gran Bretanya. Els valors de cada matriu es combinen mitjançant una operació OR, és a dir, qualsevol conjunt de dades que coincideixi amb un o més d'aquests valors s'inclourà als resultats.
- Exclou: especifica criteris per excloure determinats conjunts de dades dels resultats. Cada conjunt de dades té els seus propis camps rellevants, com ara equityType, isPrimary, region, etc. Per a cada camp, proporcioneu una matriu de valors que voleu filtrar. Per example, especificant [“EUA”, “GB”] per al camp de regió, exclourà els documents on la regió sigui els Estats Units o la Gran Bretanya. Els valors de cada matriu es combinen mitjançant una operació OR, és a dir, qualsevol conjunt de dades que coincideixi amb un o més d'aquests valors s'exclourà dels resultats.
Els clients també han de tenir aquesta configuració per als filtres d'inclusió i exclusió. La llista completa de camps, entitats i valors acceptables està disponible a la secció 2.2.4
- camp – cadena que conté el nom del camp per filtrar. Cada classe d'actiu té el seu propi conjunt de camps (és a dir, "equity_type", "is_primary", "region", etc.).
- entitat – cadena que conté la classe d'actiu per al filtre que s'ha d'aplicar. Si no s'inclou o es deixa buit, s'aplicarà el filtre a totes les classes d'actius
- valors – els valors que voleu filtrar, com a llista separada per comes. Els valors d'aquesta llista estan lligats mitjançant una operació OR. o Example: un filtre d'inclusió amb "valors": ["EUA", "GB"] inclouria documents els valors de regió dels quals siguin els Estats Units o la Gran Bretanya. Els valors possibles per a regions estan disponibles a l'Apèndix A
Sample Format de sol·licitud
Noms i valors acceptables
A continuació es mostra la llista de noms i valors admesos per a cada classe d'actius i els filtres relacionats:
| actiu
Descripció de la classe/”Entitats”. |
Valors de la classe d'actiu/“Entitats”. | Camps | Valors de camp | Descripció dels valors del camp |
| Préstecs bancaris | préstecs_bancs | |||
| Mercaderies | mercaderies | |||
| Preus avaluats contínuament | cep_bonds | |||
| Països | països | |||
| Ofertes | ofertes | |||
| Informes Econòmics | econ_informes | |||
| Econòmic
Sèrie |
sèrie_econòmica | |||
| Renta variable | accions | tipus_equitat | EQ_Primària | Mercat primari |
| EQ_PREF | Preferent
Renta variable |
|||
| EQ_RIGHTS | Drets | |||
| EQ_WARR | Les ordres | |||
| EQ_DEPOS | Dipòsit
Rebuts |
|||
| EQ_DR_ADR | ADR | |||
| EQ_DR_GDR | RDA |
| EQ_DR_NVDR | NVDR | |||
| EQ_DR_ODR | Altres DR | |||
| és_primari | 0 = fals
1 = cert |
|||
| regió | Vegeu l'annex
A |
|||
| Renta variable en temps real | accions_temps real | |||
| ETFs | etfs | regions | Vegeu l'annex
A |
|
| ETF en temps real | etfs_realtime |
| Intercanvi Tarifes en temps real | tipus_de_canvi_en temps real | |||
| Renda Fixa | enllaços | cupó | valor arbitrari | |
| maduresa_any | any arbitrari | |||
| 144a | 0 = fals
1= cert |
|||
| reg_s | 0 = fals
1= cert |
|||
| en temps_real | 0 = fals
1= cert |
|||
| termes | 0 = fals
1= cert |
|||
| Estrangers
Intercanvi |
divises | |||
| Futurs
(continu) |
futurs | |||
| Índexs | Índexs | és_primari | 0 = fals
1= cert |
|
| Índexs
Temps real |
índexs_temps real | |||
| Indústries | indústries | |||
| Préstecs Markit | markit_loans | |||
| Fons d'inversió | fons_mútus | mf_type | MUT | Fons d'inversió |
| MUT_OPEN | Fons oberts | |||
| MUT_TANCAT | Fons tancats |
| Fons d'inversió
Temps real |
fons_d'inversió_en temps real | |||
| Titulars de la propietat | propietaris_propietaris | |||
| Gent | persones | |||
| Empreses privades | empreses_privades |
| Private Equity/Venture Empreses de capital | pevc_firms | és_fill | 0 = fals
1= cert |
|
| is_shell | 0 = fals
1= cert |
|||
| Private Equity/Venture Fons de capital | pevc_funds | és_fill | 0 = fals
1= cert |
|
| is_shell | 0 = fals
1= cert |
|||
| Regió | regions | |||
| Rendiments | rendiments |
Configuració
Permet als usuaris ajustar el comportament de la sol·licitud i la resposta.
| Nom | Valor | Descripció |
| resultat_límit | Valor arbitrari | Nombre de resultats a retornar per la cerca. Nombre màxim de resultats = 25*; camp predeterminat és 10 si
no s'utilitza. |
Sampla consulta
Aquest exampli sol·licita que només es tornin els 25 primers resultats.
Samples
Consulta senzilla
Aquesta senzilla consulta sol·licita les 10 millors coincidències a la base de dades de persones de FactSet amb el nom Gates:
Aquests són els 10 millors resultats amb Gates al nom. El valor del símbol s'associa amb el nom de l'entitat relacionada. Aquest podria ser un símbol de ticker per a accions o un identificador únic de FactSet per a una altra classe d'actius com ara una empresa privada. El símbol és l'únic valor que s'ha de retornar a qualsevol servei de FactSet per recuperar dades.
Example: si voleu recuperar la instantània de persones per a Bill Gates, hauríeu de passar 00118X-E (i no Bill Gates, III) al paràmetre del servei FactSet que utilitzeu.
Resultats
De manera predeterminada, l'API retorna 10 resultats per classe d'actiu que coincideixen molt amb la consulta. Per example, si la consulta sol·licita dues "entitats", aleshores l'API retornaria 20 resultats. A continuació es mostra la resposta del sampconsulta de la secció 2.3.1:
Sampconsulta amb un filtre
En aquest example, la consulta busca enllaços que tinguin "US" al seu nom. També estem establint un filtre per retornar els bons que tinguin una data de venciment el 2021.
Aquesta és la resposta de la consulta:
Sampconsulta amb la lògica OR
La lògica O s'estableix establint diversos valors dins del mateix bloc, separats per una coma. En aquest example, la consulta està cercant accions O empreses privades que tinguin la paraula aire al seu nom. No estem establint cap filtre per a aquesta consulta.
Aquesta és la resposta a la consulta anterior:
Sampconsulta amb la lògica AND
En aquest example, la consulta està buscant una renda fixa que tingui la paraula vida al seu nom. També estem establint un filtre AND per retornar només aquells bons que s'ofereixen com a Reg S i tenen una data de venciment el 2020.
Aquesta és la resposta a la consulta:
Sampconsulta amb la lògica OR i AND
En aquest example, la consulta està cercant accions que tinguin el grup de paraules al seu nom. Només ens interessen els rebuts de dipòsit global (GDR) que es troben a Gran Bretanya o Alemanya.
Aquesta és la resposta a la consulta:
Apèndix
A1. Valor acceptable per al camp Regió
A continuació es mostra la llista de codis de països acceptables per al camp Regió
| Codi de país | Nom del país |
| AF | Afganistan |
| AL | Albània |
| DZ | Algèria |
| AD | Andorra |
| AO | Angola |
| AI | Anguilla |
| AG | Antigua i Barbuda |
| AR | Argentina |
| AM | Armènia |
| AW | Aruba |
| AU | Austràlia |
| AT | Àustria |
| AZ | Azerbaidjan |
| BS | Bahames |
| BH | Bahrain |
| BD | Bangla Desh |
| BB | Barbados |
| BY | Bielorússia |
| BE | Bèlgica |
| BZ | Belize |
| BM | Bermudes |
| BT | Butan |
| BO | Bolívia |
| BA | Bòsnia i Hercegovina |
| BW | Botswana |
| BR | Brasil |
| BG | Bulgària |
| KH | Cambodja |
| CM | Camerun |
| CA | Canadà |
| CV | Cap Verd |
| KY | Illes Caiman |
| TD | Txad |
| CL | Xile |
| CN | Xina |
| CO | Colòmbia |
| CK | Illes Cook |
| CR | Costa Rica |
| HR | Croàcia |
| CW | Curaçao |
| CY | Xipre |
| CZ | República Txeca |
| DK | Dinamarca |
| DO | República Dominicana |
| EC | Equador |
| EG | Egipte |
| SV | El Salvador |
| EE | Estònia |
| FO | Illes Fèroe |
| FJ | Fiji |
| FI | Finlàndia |
| FR | França |
| GE | Geòrgia |
| DE | Alemanya |
| GH | Ghana |
| GI | Gilbraltar |
| GR | Grècia |
| GT | Guatemala |
| GG | Guernsey |
| GY | Guyana |
| HN | Hondures |
| HK | Hong Kong |
| HU | Hongria |
| IS | Islàndia |
| IN | Índia |
| ID | Indonèsia |
| IR | Iran |
| IQ | Iraq |
| IE | Irlanda |
| IM | Illa de Man |
| IL | Israel |
| IT | Itàlia |
| CI | Costa d'Ivori |
| JM | Jamaica |
| JP | Japó |
| JE | Jersey |
| JO | Jordània |
| KZ | Kazahkstan |
| KE | Kenya |
| KR | Corea del Sud |
| KW | Kuwait |
| KG | Kirguizistan |
| LA | Laos |
| LV | Letònia |
| LB | Líban |
| LR | Libèria |
| LY | Líbia |
| LI | Liechtenstein |
| LT | Lituània |
| LU | Luxemburg |
| MO | Macau |
| MK | Macedònia |
| MG | Madagascar |
| MW | Malawi |
| MY | Malàisia |
| MV | Maldives |
| MT | Malta |
| MH | Illes Marshall |
| MU | Maurici |
| MX | Mèxic |
| MD | Moldàvia |
| MC | Mònaco |
| MN | Mongòlia |
| ME | Montenegro |
| MA | el Marroc |
| MZ | Moçambic |
| MM | Myanmar |
| NA | Namíbia |
| NP | Nepal |
| NC | Nova Caledònia |
| NZ | Nova Zelanda |
| NI | Nicaragua |
| NG | Nigèria |
| NO | Noruega |
| OM | Oman |
| PK | Pakistan |
| PS | Palestina |
| PA | Panamà |
| PG | Papua Nova Guinea |
| PY | Paraguai |
| PE | Perú |
| PH | Filipines |
| PL | Polònia |
| PT | Portugal |
| PR | Puerto Rico |
| QA | Qatar |
| RO | Romania |
| RU | Rússia |
| RW | Ruanda |
| KN | Saint Kitts i Nevis |
| LC | Santa Llúcia |
| VC | Sant Vicenç i les Granadines |
| SA | Aràbia Saudita |
| RS | Sèrbia |
| SC | Seychelles |
| SG | Singapur |
| SK | Eslovàquia |
| SI | Eslovènia |
| ZA | Sud-àfrica |
| ES | Espanya |
| LK | Sri Lanka |
| SD | Sudan |
| SZ | Swazilàndia |
| SE | Suècia |
| CH | Suïssa |
| SY | Síria |
| TW | Taiwan |
| TJ | Tadjikistan |
| TZ | Tanzània |
| TH | Tailàndia |
| NL | Els Països Baixos |
| TT | Trinitat i Tobago |
| TN | Tunsia |
| TR | Turquia |
| TC | Illes Turks i Caicos |
| UG | Uganda |
| UA | Ucraïna |
| AE | Unió dels Emirats Àrabs |
| EU | Regne Unit |
| GB | Regne Unit |
| UM | Illes menors perifèriques dels Estats Units (les) |
| US | Estats Units d'Amèrica |
| UY | Uruguai |
| UZ | Uzbekistan |
| VU | Vanuatu |
| VE | Veneçuela |
| VN | Vietnam |
| VG | Illes Verges (Britàniques) |
| VI | Illes Verges (EUA) |
| YE | Iemen |
| ZM | Zàmbia |
| ZW | Zimbabwe |
A2. Codis de resposta
Aquests són els codis de resposta que retorna l'API de cerca d'ID:
|
429 |
S'ha assolit el límit de l'API segons la secció 1.4 |
| 500 |
Possible format de consulta incorrecte (per exemple, falten comes, parells de claudàtors, etc.) |
Documents/Recursos
 |
Programari FACTSET ID Lookup API [pdfGuia de l'usuari Programari API de cerca d'ID, programari API de cerca, programari API, programari |