API Credits and API Cap
About API credits and Cap
Each API endpoint has a specific cost, outlined in the tables below. The cost is either calculated based on iterations or data points. DataMiner operations may use multiple API endpoints so their costs is the sum of all the endpoints used.
You monthly API credit cap depends on your membership (see pricing page). Your remaining credits are displayed on the Dashboard and also on the DataMiner & API tab in Account Settings. Unused credits of your monthly cap do not roll over to the next month. When you reach your monthly cap you can purchase additional credits on demand. Purchased credits never expire and are only used when you reach your monthly cap.
Iteration based
DataSeries | Multiple API endpoints are available to create, update, delete or upload data to an imported data series. 1 credit. |
RankPerformance | Rank performance data for a date range: 3 credits. NOTE: The DataMiner has an operation called RankPerformance which is not the same as this endpoint. The DataMiner operation calls this endpoint once per bucket and its cost depends on the number of buckets. |
RanksMulti | Ranks for universe on a date. 2 credits per Ranking system. |
RanksPeriod | Ranks for a Universe for a date range. 2 credits per date. |
RollingScreen | Multiple screens over date range. 5 credits per version of the screen. |
ScreenBacktest | Screen backtest over a date range. 5 credits. |
ScreenRun | Runs a screen for a date. 2 credits. |
StockFactor | Multiple API endpoints are available to create, update, delete or upload data to an imported stock factor. 1 credit. |
Strategy | Returns the data from strategies and books. 1 credit. |
Data point based
Each 100,000 data points will count as 1 API request credit. Multiplying the number of rows times the number of columns of the data returned gives you the number of data points. The minimum cost for each call is 1 credit.
Data * | Formula values for tickers for a date range. Data point is the number of stock, date and formula combinations. |
DataUniverse * | Formula values for universe on a date. Data point is the number of stock, date and formula combinations. |
Ranks | Ranks for universe on a date. The number of columns returned depends on what options you have selected in your script for the 'columns' parameter and if you have requested any formulas in the Additional Data section. |
*A data license with the vendor is required for certain data points
Inline Universe or Ranking System
For all of the above there is a cost of 1 additional request credit any time you define (or "inline") a ranking system or universe within the script.
Did this answer your question?