To make API calls, you need to include the identifiers. These can be one of four types: assets, tickers, legal_ids, or full_tickers.
Note: CityFALCON does not publish legal_ids. Please find them from external sources, such as company filings with local authorities. If your system is already based on legal_ids, contact us about using them in your API calls.
Finding tickers and assets
Tickers are publicly available, provided by financial data suppliers, corporate websites, and on CityFALCON.
Assets, which are specific to CityFALCON, are easily found on the website. Simply search for the company, topic, person, organisation, or whatever your target is in a search box, which will show you something like this:
The red box indicates the
assets name, while the blue box shows the associated
tickers. The first ticker here, DBK, is Deutsche Bank's ticker on the Frankfurt Stock Exchange, while DB is Deutsche Bank's ticker for its US-based issue on the New York Stock Exchange. Naturally, non-company entities will not have tickers.
If you use assets, make sure to include the spaces in the name when you make the API call.
Finding full tickers
While asset names are unique in the database and will never conflict, tickers are not. In some cases, such as for AAL, the sequence of letters in the ticker is shared between companies in different countries. If you make an API call with the shortened ticker AAL, we do not know which company you're searching for:
For that reason, we recommend using the so-called
You will need to know in which country the company you seek has listed on an exchange and the ticker in that country. Then you can build the full ticker by appending an underscore and the country code to the regular ticker.
Using AAL, we have
- AAL_US for American Airlines Group
- AAL_GB for Anglo American
- AAL_CA for Advantage Lithium Corp
- AAL_AU for Apac Coal Ltd.
If a company has tickers in more than one country, you will need to choose the right ticker and country. Using Deutsche Bank:
- DBK is traded in Frankfurt, Germany, so its full ticker is DBK_DE
- DB is listed in the US, thus DB_US
Finding full tickers for cryptocurrencies
full_ticker requires a country, but cryptocurrencies have no country, you can use GLBL or GLOBAL as the "country" identifier. For example, you can use BTC_GLBL or BTC_GLOBAL when using the
full_ticker field for Bitcoin.