Skip to main content
API FAQs

FAQs on Tracxn APIs

Tracxn avatar
Written by Tracxn
Updated over 2 months ago

Getting Started

1. Which databases are available via APIs?

See the full list of APIs currently available on API Overview. If you did not find what you were looking for, please reach out to our support team with your request. It will help us prioritise.

2. How to get access token for using Tracxn APIs?

You can generate a new API token on the API Token page.


API Sandbox

1. Is there a sandbox environment available for testing?

Yes, we have a free API sandbox environment that you can try out. Refer Sandbox Environment for more details. The sandbox environment gives you access to the Cybersecurity feed and all the companies, funding rounds, acquisitions, investors, sectors (Practice Area/Feed/Business Models) under it.

2. Is there a separate token for sandbox and production environments?

No, you can use the same token for both the environments. You only need to change the endpoint URLs.


API Credits

1. Are all credit types the same? I have Export Credits available to me. Can I use them for using Tracxn APIs?

No, separate credits are provided for Platform Exports and APIs. To access our APIs please contact our API desk team. To test our APIs without consuming credits, try our Sandbox Environment.

2. How Are API Credits allocated and reset?

API credits are allocated at the beginning of each subscription cycle based on your subscription plan. These credits are associated with your organisation's account and are shared among users within the organisation. They are reset according to your subscription plan.

3. How are API credits deducted?

1 API credit is deducted for each entity (i.e a Company in case of Companies API, a Funding Round in case of Transactions API, an Investor in case of Investors API and so on) returned in the API response. For instance, if your call to Companies API retrieves 15 companies, 15 API credits will be deducted.

4. Are credits deducted when no results are returned?

No, credits are only deducted when the API response includes an entity available in our dataset. If no data matches your query criteria, no credits will be deducted. Credits are used only when you get an entity in API response.

5. How do I check the number of available API credits?

Refer to the Credit Details page to view the number of available credits available to you.

6. What happens when my credits are exhausted?

If you exhaust your credits, the API will respond with HTTP code - 403 and the message "API out of credits". Feel free to reach out to our support team to request additional credits.

7. My API query matched hundreds of entities. Will I get all these matched entities together as a response to a single API call? How will credit deduction work?

Each API call can return a maximum of 20 entities. If you need to get all the matched entities, you need to make multiple API calls and paginate through all the matched entities. Credits are deducted only for companies which you get in API response. Therefore, in this case credits will be deducted in multiples of 20 as you paginate through all the entities.

8. Do I Get Charged for fetching data for the same Company again?

Yes, you will be charged a credit when fetching data for a company again. We do not differentiate between initial data retrieval and data updates. For the complete list of output keys available in the API response, refer to the "Output Keys" section on the corresponding API reference pages.


API Request Body

1. How do I see the list of available filters for each of the APIs?

See the full list of available filters for each API in the corresponding API reference pages > Filters Applicable.

2. What is the default 'size' parameter?

The default and maximum value for 'size' parameter for API responses is set to 20. If you require fewer than 20 entities in the API response, you can use this parameter to reduce the result size.


API Response

1. What data is included in the API response?

To find the list of data points included in the API response, refer to the "Output Keys" section on the corresponding API reference page. If the API does not return a specific data point that you can see on the platform, please reach out to our support team with your query. We will assess the feasibility of supporting your use case and provide assistance accordingly.

2. Can I customise the fields returned in the API response?

Currently, the API response will include all data points. The option to customise response to limit to specific fields is currently not available.

3. I want the entities in the API response sorted in a particular order. How do I do that?

See the full list of attributes by which you can sort the entities in the API response in corresponding API reference pages > Sorts applicable.

4. What happens in case a datapoint is not available in your database? What will the API response look like?

API responses will not contain datapoints for which we do not have values available in our database. This is to reduce the API response packet size. You will need to handle for this scenario while integrating with the APIs.


Miscellaneous

1. How are Companies uniquely identified in Tracxn database?

Companies are primarily identified by their normalised website domain in our database. Additionally, we provide database IDs (id/tracxnId) for all entities, which can also serve as primary identifiers for any entity inside the Tracxn database.

2. How can I check if an entity was updated or when was it updated?

Currently, there is no option to check for entity updates or determine when the last update was made. Due to the extensive number of data points available for each entity, maintaining updated date-time is challenging.

3. Is server-side push or webhooks supported?

Currently, we do not support server-side push. However, this feature is on our development roadmap.

4. What if the desired company is not available in your database?

If a company is not found in our database, the API will not return this company in the response, and no credits will be deducted. You can submit a curation request on our platform to have the company added/curated to our database.

Did this answer your question?