Skip to main content

​
Credit System and Caching

Topograph uses a credit-based system with smart caching.

​
How Credits Work

To use the API, you need to purchase credits in advance, using the Topograph web app (you need to be administrator of your organization). Each data point or document request uses a specific number of credits from your balance. When your balance becomes negative, API requests will be blocked. If your account remains unfunded for 30 days after going negative, we will invoice you for the negative amount.

​
Automatic Cost Optimization

Our 24-hour caching system is designed to optimize your costs while maintaining data freshness. When you request a data point or document, the result is automatically cached for 24 hours. Subsequent requests for the same item within the period will be served from the cache without consuming additional credits. You can also retrieve previously requested data by calling the requestId of your initial request. Requests made with a requestId are never billed, regardless of the caching period, as they simply return the data from your original request.

​
Best Practices

Regularly monitor your balance in the Topograph web app. Consider batching similar requests within the 24-hour cache window to take advantage of the caching system. For high-volume operations, you may want to store the requestId of your requests to retrieve the data multiple times without additional charges.

​
Retrieving Prices

You can retrieve the Topograph unit prices for a specific country using the pricing endpoint. Example use cases include:
  • Understanding the price of requests before running them
  • Displaying price information to end-users
  • Budgeting and planning purposes

​
Endpoint

POST https://api.topograph.co/v2/pricing

​
Request

{
  "country": "FR" // ISO country code
}
The response lists available data points (company profile, UBO, etc.) and their respective unit price. The prices for document retrieval are retrieved using the availableDocuments dataPoint of the company endpoint.
Company searches and lists of available documents are free on Topograph.
Prices are returned in credits and may vary based on your subscription plan.

​
Example Request

curl --request POST \
  --url https://api.topograph.co/v2/pricing \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
    "country": "FR"
  }'

​
Enterprise Solutions

For high-volume usage, custom solutions are available with custom pricing plans, custom cache periods and dedicated implementation support. Contact sales@topograph.co to discuss your needs.