How API credits are charged
This section describes the API credits charging logic. How much and for what credits are charged for module methods:
- Search analysis (the methods for domains, keywords and URLs analysis)
- Backlink analysis
- Rank tracker
- Audit
- Export
1. API V4 methods.
1.1 The table shows how API credits are charged for domain methods.
Method V4 | Procedure name | How credits are charged |
1. Domain summary | SerpstatDomainProcedure.getDomainsInfo | 5 credits for 1 part of the response |
2. Domain history | SerpstatDomainProcedure.getDomainsHistory | 1 credit for 1 part of the response |
3. Domain's organic keywords | SerpstatDomainProcedure.getDomainKeywords | |
4. List of domain's URLs | SerpstatDomainProcedure.getDomainUrls | |
5. Domains' keywords intersection | SerpstatDomainProcedure.getDomainsIntersection | |
6. Domain's general and unique keywords | SerpstatDomainProcedure.getDomainsUniqKeywords | |
7. Competitors in organic search | SerpstatDomainProcedure.getCompetitors | |
8. Domain's ads | SerpstatDomainProcedure.getAdKeywords | |
9. Domain's top pages | SerpstatDomainProcedure.getTopUrls | |
10. Competitors in PPC | SerpstatDomainProcedure.getAdsCompetitors |
1.2 The table shows how API credits are charged for keywords methods.
Method V4 | Procedure name | How credits are charged |
1. Keywords selection | SerpstatKeywordProcedure.getKeywords | 1 credit for 1 part of the response |
2. Keyword's overview | SerpstatKeywordProcedure.getKeywordsInfo | |
3. Keyword's search suggestions | SerpstatKeywordProcedure.getSuggestions | |
4. Related keywords | SerpstatKeywordProcedure.getRelatedKeywords | |
5. Keyword's top | SerpstatKeywordProcedure.getKeywordTop | |
6. Keyword's competitors in organic | SerpstatKeywordProcedure.getCompetitors | |
7. Keyword's ads | SerpstatKeywordProcedure.getAdKeywords | |
8. Keyword's competitors in PPC | SerpstatKeywordProcedure.getAdsCompetitors |
1.3 The table shows how API credits are charged for using URL methods.
Method V4 | Procedure name | How credits are charged |
1. URL organic keywords | SerpstatUrlProcedure.getUrlKeywords | 1 credit for 1 part of the response |
2. URL competitors | SerpstatUrlProcedure.getUrlCompetitors | |
3. URL's missing keywords | SerpstatUrlProcedure.getUrlMissingKeywords | |
4. Traffic by URL mask | SerpstatUrlProcedure.getSummaryTraffic | 1000 API credits for 1 request |
1.4 The table shows how API credits are charged for backlinks methods.
Method V4 | Procedure name | How credits are charged |
1. Summary report | getSummary | 5 credits for 1 part of the response |
2. Referring domains | getRefDomains | 1 credit for 1 part of the response |
3. Malicious domains-donors | getThreats | |
4. Malicious pages-donors | getThreatsLinks | |
5. Malicious domains-acceptors | getOutThreats | |
6. Malicious pages-acceptors | getOutThreаtsLinks | |
7. Active backlinks | getNewBacklinks | |
8. Lost backlinks | getLostBacklinks | |
9. External active links | getOutlinks | |
10. External lost links | getLostOutlinks | |
11. External domains | getOutDomains | |
12. Anchors | getAnchors | |
13. Top Pages | getTopPages | |
14. Links intersection — summary | getIntersectSummary | |
15. Links intersection — detailing | getIntersect | |
16. Backlinks dynamics | getBacklinksChangesHistory |
1.5 The table shows how API credits are charged for Rank tracker methods.
Method V4 | Procedure name | How credits are charged |
1. The list of project regions and their status | getProjectRegions | These methods don't require API credits |
2. The list of domains from top 20 project keywords | getTopCompetitorsDomainsHistory | |
3. The list of pages and their positions by a domain | getUrlsSerpResultsHistory | |
4. The search results history in region by keywords | getKeywordsSerpResultsHistory | |
5. The list of projects and their status | RtApiProjectProcedure.getProjects |
1.6 The table shows how API credits are charged for site audit methods.
Method V4 | Procedure name | How credits are charged |
1. Site audit start | AuditSite.start | These methods don't require credits |
2. List of carried out audits | getList | |
3. Stop running audit | AuditSite.stop | |
4. Audit's basic information | getBasicInfo | |
5. Value of default settings in a project | getDefaultSettings | |
6. Project's settings | getSettings | |
7. Audit settings saving | setSettings | |
8. URLs list for scanning | getScanUserUrlList | |
9. History of project changes by issue categories | getHistoryByCountError | |
10. Report issues list | getReportWithoutDetails | |
11. Issue element's data | getErrorElements | |
12. Issue subelements data | getSubElementsByCrc | |
13. Issue categories statistics | getCategoriesStatistic | |
14. Summary report export | AuditSite.export |
2. API V3 methods.
2.1 The table shows how API credits are charged for domain methods.
Method V3 | Procedure name | How credits are charged |
1. Domain summary | domain_info | 5 credits for 1 part of the response |
2. Domain history | domain_history | 1 credit for 1 part of the response |
3. Domain's organic keywords | domain_keywords | |
4. List of domain's URLs | domain_urls | |
5. Domains' keywords intersection | domains_intersection | |
6. Domain's general and unique keywords | domains_uniq_keywords | |
7. Competitors in organic search | competitors | |
8. Domain's ads | ad_keywords | |
9. Domain's top pages | get_top_urls |
2.2 The table shows how API credits are charged for keywords methods.
Method V3 | Procedure name | How credits are charged |
1. Keywords selection | keywords | 1 credit for 1 part of the response |
2. Keyword's overview | keyword_info | |
3. Keyword's search suggestions | suggestions | |
4. Related keywords | related_keywords | |
5. Top for a keyword | keyword_top | |
6. Top keywords | top_words |
2.3 The table shows how API credits are charged for using URL methods.
Method V3 | Procedure name | How credits are charged |
1. URL organic keywords | url_keywords | 1 credit for 1 part of the response |
2. URL competitors | url_competitors | |
3. URL's missing keywords | url_missing_keywords |
2.4 The table shows how API credits are charged for export methods.
Method V3 | Procedure name | How credits are charged |
1. Domain's positions export | export_positions_csv | 1 API credit for 1 response row |
2. Related keywords export | export_keywords_csv | |
3. Search suggestions export | export_suggestions_csv |