Find answers to frequently asked questions here. The links below link directly to the anchored text on this page for convenient navigation.
- What’s the delay between publication and availability on the API?
- May I redistribute the data via API, RSS, XML or similar methods?
- Are there call limits? Do you offer a streaming Websockets service?
- Where can I get help with implementation?
- Why can’t I find a particular publication? Can I request one?
- Which CityFALCON features (CF score, sentiment, etc.) are available on the API?
- Other finance websites have free APIs. Will you have one in the future?
- I love your platform but never coded before. Can you help me build my application?
- Can I search historical data?
- What content is available through the API?
- What types of search are available?
What’s the delay between publication and availability on the API?
The delay between publication and appearance on our site can be anywhere from milliseconds to a few minutes depending on the policy of the publication. Some publications make their content available instantly while others stipulate we slightly delay content that is published on their website.
May I redistribute the data via API, RSS, XML or similar methods?
No, we generally do not allow redistribution of the content we provide to you. By default, you are only allowed to show the content on your website or apps to your users or clients. You can not redistribute via API or similar methods.
Please see our Terms of Service for the CityFALCON API for more clarity and legal requirements.
Are there call limits? Do you offer a streaming Websockets service?
There are call limits based on your plan. We have per-hour limits to control usage to a reasonable level to prevent overwhelming our infrastructure, and we have monthly limits by plan level. See our plans for specifics.
We currently do not have any streaming or Websockets services, but we plan to release these features in the future.
Where can I get help with implementation?
We have documentation available for developers. If you need further assistance, we may be able to help if you contact us.
You might find some answers in our Knowledge Base as well.
Why can’t I find a particular publication? Can I request one?
Our sources number over 2000 publications, which we have curated specifically for financial and business content. If you cannot find a publication you want, let us know with a brief explanation. We will review the request, and, if the publication meets our standards for content and credibility, we will add it.
We do appreciate any feedback from users and by telling us about publications, you help us grow our service, too. So don’t hesitate to tell us which publications you want to see included.
However, please note that some publications ask to not be included in our API service, and we respect their wishes.
Which CityFALCON features (CF score, sentiment, etc.) are available on the API?
The main GET Stories call takes multiple parameters, such as language, domain, identifiers, and minimum CityFALCON score. Which parameters are accessible depends on which subscription plan you choose.
The response is a list of stories, and each story is a JSON dictionary with the Title, Description, associated NLU tags, CityFALCON score, duplicate count, source, author, and language as fields/keys. As other analytics come online, we will extend them to the API. This includes features like Sentiment Analysis and Similar Stories. Exactly which fields are returned depends on your subscription as well.
See the basic documentation for more parameters, fields, and details. Contact us for advanced documentation if you hold an enterprise Premium plan.
Other finance websites have free APIs. Will you have one in the future?
We intend to release a personal and non-commercial use version of our API for consumers and business in the future. You will still need an authentication token, but it is as simple as signing up. The token will be automatically generated for you and you can start right away.
Until the free version is available, we have a personal, non-commercial use version that is affordable for retail users who do not have deep pockets. Check out the Personal Starter API plan.
I love your platform but never coded before. Can you help me build my application?
This depends on multiple factors. We are able to assist with setting up your API access and with some questions. We won’t be able to build the entire application for you, though.
We are launching a consulting service for enterprises to help them implement projects from start to finish. Reach out to us if you have any interest.
Can I search historical data?
Yes, you can choose the date range and look back into our archives as far as 2014, depending on your chosen plan. However, due to the volume of data, we limit the query range to one month. For example, you may search 30 Aug 2015 to 30 Sep 2015. On the other hand, 30 Aug 2015 to 15 Dec 2016 will return an error.
If you need more than 10,000 stories at once, or if you require a longer query range, consider our Historical Data Sets. These are convenient CSV files of content along with their associated analytics, and they can contain an unlimited number of instances.
What content is available through the API?
Most of the content you would see as a regular user is available via the API. You'll get news stories, CityFALCON analytics, video content, and filings. Of course, some components are only available at the higher API plans.
However, Premium Content and Twitter information will require their own licenses. You will need to contact Twitter or the content provider to obtain them. Once you provide proof of your license(s), we will be able to relay their data to you via API. Contact us for details and to confirm the availability of data.
What types of search are available?
All pricing tiers can search by tickers and CityFALCON topics, which are the named entities in our database. Such named entities include stocks, private companies, individual persons, organisations, and many others.
Higher API tiers have more comprehensive search access, including locations (countries, cities, etc.) and aggregated entities. Aggregated entities are a taxonomic structure that groups topics. Sector categories are a traditional example. CityFALCON also offers Topic Classes, groups of topics that naturally fit together. Stocks, Events, Macro Topics, and many others make up these classes. See the full list.