API
Reference
This document provides a central location for reference materials such as definitions, codes, and error details that you may need when working with the SE Ranking API.
Glossary
A list of common terms and their definitions used throughout the API documentation.
| Term | Definition |
|---|---|
| Backlink (link) | A reference to the target URL in the form of a link, redirect, redirect chain, or canonical link that comes from a different domain than the target. |
| Domain | A subdomain is a domain that is a part of another domain, e.g., sub.domain.com is a subdomain of domain.com. |
| Subdomain | A host is a domain name that is completely specified with all labels in the hierarchy of the DNS, having no parts omitted, e.g., in the URL https://www.example.sub.domain.com/path, the hostname will be www.example.sub.domain.com. |
| Host | A page that sends users to your website via links or redirects. |
| Page (URL) | A reference to a web resource that specifies its location on a computer network and a mechanism for retrieving it. |
| Referring page (URL) | A page that sends users to your website via links or redirects. |
| Destination page (URL) | A page that a link or redirect leads to. |
| Referring domain | A hostname of the referring page (URL). |
| Target | An entity for which you are retrieving backlinks. Can be determined at an exact URL, domain, or subdomain. |
| Anchor text | Clickable text in a hyperlink. |
| Nofollow | A value that can be assigned to the rel attribute in the <a> tag or robots meta tag. It is one of Google’s recommended methods for flagging spam, advertising-related, or sponsored links. Nofollow links don’t normally pass SEO weight to the destination URL. |
| InLink Rank | An indicator of a page’s authority, based on the same algorithm as the original Google PageRank. It is determined by the number and weight of incoming links to a page. InLink Rank is scored on a logarithmic scale from 0 to 100, with higher scores indicating greater authority. |
| Domain InLink Rank | An indicator of a domain’s authority. Like InLink Rank, Domain InLink Rank can be used to assess the domains that links come from. |
Regional database codes
Use one of the following codes as the value of the source parameter when you want a request to target a specific regional keyword database. The list mirrors the ISO 3166-1 alpha-2 country codes, with the addition of worldwide.
| Code | Country/region |
|---|---|
| af | Afghanistan |
| al | Albania |
| dz | Algeria |
| as | American Samoa |
| ao | Angola |
| ai | Anguilla |
| ag | Antigua and Barbuda |
| ar | Argentina |
| am | Armenia |
| aw | Aruba |
| au | Australia |
| at | Austria |
| az | Azerbaijan |
| bs | Bahamas |
| bh | Bahrain |
| bd | Bangladesh |
| bb | Barbados |
| by | Belarus |
| be | Belgium |
| bz | Belize |
| bj | Benin |
| bt | Bhutan |
| bo | Bolivia |
| ba | Bosnia and Herzegovina |
| bw | Botswana |
| br | Brazil |
| vg | British Virgin Islands |
| bn | Brunei |
| bg | Bulgaria |
| bf | Burkina Faso |
| bi | Burundi |
| cv | Cabo Verde |
| kh | Cambodia |
| cm | Cameroon |
| ca | Canada |
| ky | Cayman Islands |
| cf | Central African Republic |
| td | Chad |
| cl | Chile |
| cn | China |
| co | Colombia |
| cd | Congo (Democratic Republic) |
| cg | Congo (Republic) |
| ck | Cook Islands |
| cr | Costa Rica |
| ci | Côte d’Ivoire |
| hr | Croatia |
| cu | Cuba |
| cy | Cyprus |
| cz | Czechia |
| dk | Denmark |
| dj | Djibouti |
| dm | Dominica |
| do | Dominican Republic |
| ec | Ecuador |
| eg | Egypt |
| sv | El Salvador |
| gq | Equatorial Guinea |
| ee | Estonia |
| et | Ethiopia |
| fo | Faroe Islands |
| fj | Fiji |
| fi | Finland |
| fr | France |
| gf | French Guiana |
| pf | French Polynesia |
| ga | Gabon |
| gm | Gambia |
| ge | Georgia |
| de | Germany |
| gh | Ghana |
| gi | Gibraltar |
| gr | Greece |
| gl | Greenland |
| gd | Grenada |
| gp | Guadeloupe |
| gu | Guam |
| gt | Guatemala |
| gg | Guernsey |
| gn | Guinea |
| gy | Guyana |
| ht | Haiti |
| hn | Honduras |
| hk | Hong Kong |
| hu | Hungary |
| is | Iceland |
| in | India |
| id | Indonesia |
| iq | Iraq |
| ie | Ireland |
| im | Isle of Man |
| il | Israel |
| it | Italy |
| jm | Jamaica |
| jp | Japan |
| je | Jersey |
| jo | Jordan |
| kz | Kazakhstan |
| ke | Kenya |
| ki | Kiribati |
| kw | Kuwait |
| kg | Kyrgyzstan |
| la | Laos |
| lv | Latvia |
| lb | Lebanon |
| ls | Lesotho |
| ly | Libya |
| li | Liechtenstein |
| lt | Lithuania |
| lu | Luxembourg |
| mg | Madagascar |
| mw | Malawi |
| my | Malaysia |
| mv | Maldives |
| ml | Mali |
| mt | Malta |
| mq | Martinique |
| mr | Mauritania |
| mu | Mauritius |
| yt | Mayotte |
| mx | Mexico |
| fm | Micronesia |
| md | Moldova |
| mc | Monaco |
| mn | Mongolia |
| me | Montenegro |
| ms | Montserrat |
| ma | Morocco |
| mz | Mozambique |
| mm | Myanmar |
| na | Namibia |
| nr | Nauru |
| np | Nepal |
| nl | Netherlands |
| nc | New Caledonia |
| nz | New Zealand |
| ni | Nicaragua |
| ne | Niger |
| ng | Nigeria |
| nu | Niue |
| mk | North Macedonia |
| no | Norway |
| om | Oman |
| pk | Pakistan |
| pa | Panama |
| pg | Papua New Guinea |
| py | Paraguay |
| pe | Peru |
| ph | Philippines |
| pn | Pitcairn Islands |
| pl | Poland |
| pt | Portugal |
| pr | Puerto Rico |
| qa | Qatar |
| re | Réunion |
| ro | Romania |
| ru | Russia |
| rw | Rwanda |
| sh | Saint Helena |
| kn | Saint Kitts and Nevis |
| lc | Saint Lucia |
| vc | Saint Vincent and the Grenadines |
| ws | Samoa |
| sm | San Marino |
| st | São Tomé and Príncipe |
| sa | Saudi Arabia |
| sn | Senegal |
| rs | Serbia |
| sc | Seychelles |
| sl | Sierra Leone |
| sg | Singapore |
| sk | Slovakia |
| si | Slovenia |
| sb | Solomon Islands |
| so | Somalia |
| za | South Africa |
| kr | South Korea |
| es | Spain |
| lk | Sri Lanka |
| ps | State of Palestine |
| sr | Suriname |
| se | Sweden |
| ch | Switzerland |
| tw | Taiwan |
| tj | Tajikistan |
| tz | Tanzania |
| th | Thailand |
| tl | Timor-Leste |
| tg | Togo |
| tk | Tokelau |
| to | Tonga |
| tt | Trinidad and Tobago |
| tn | Tunisia |
| tr | Türkiye |
| tm | Turkmenistan |
| vi | U.S. Virgin Islands |
| ug | Uganda |
| ua | Ukraine |
| ae | United Arab Emirates |
| uk | United Kingdom |
| us | United States |
| uy | Uruguay |
| uz | Uzbekistan |
| vu | Vanuatu |
| ve | Venezuela |
| vn | Vietnam |
| ye | Yemen |
| zm | Zambia |
| zw | Zimbabwe |
Note: If a code you send is not supported, the API returns: 400 Invalid source.
SERP features
Use one of the following codes as the value of the serp_features parameter when you want a request to target keywords with specific SERP features.
| Code | Feature |
|---|---|
| featured_snippets | Featured Snippets |
| local_pack | Local Pack |
| reviews | Reviews |
| sitelinks | Sitelinks |
| video | Video |
| carousel_results | Carousel Results |
| top_stories | Top Stories |
| people_also_ask | People Also Ask |
| images | Images |
| knowledge_graph | Knowledge Graph |
| knowledge_card | Knowledge Card |
| tads | Tads |
| bads | Bads |
| shopping_results | Shopping Results |
| amp | Amp |
| no | No |
| hotel_pack | Hotel Pack |
| research | Research |
| jobs | Jobs |
| see_results_about | See Results About |
| flights | Flights |
| find_results_on | Find Results On |
| events | Events |
| calculator | Calculator |
| maps | Maps |
| refine_by | Refine By |
| digital_complaints | Digital Complaints |
| trip_cards | Trip Cards |
| recipes | Recipes |
| appbar_events | Appbar Events |
| sports_app | Sports App |
| podcasts | Podcasts |
| gmb | Gmb |
| questions | Questions |
| popular_times | Popular Times |
| location | Location |
| destination | Destination |
| faq | Faq |
| sge | AI overview |
| videos_block | Videos Block |
| related_searches | Related Searches |
| image_in_block | Image In Block |
| marketplace | Marketplace |
| shopping_results_side | Shopping Results Side |
| shopping_results_top | Shopping Results Top |
| shopping_results_main_block | Shopping Results Main Block |
| datasets | Datasets |
| things_to_do | Things To Do |
| places_sites_products | Places Sites Products |
| buying_guide | Buying Guide |
| currency_converter | Currency Converter |
| units_converter | Units Converter |
| stocks_block | Stocks Block |
| math_solve_block | Math Solve Block |
| discussions_and_forums | Discussions And Forums |
| sads | Sads |
| mads | Mads |
Error handling
If a request to the API fails, the HTTP response will include an error code and a detailed description in the response body.
| Code | Error text | Solution/explanation |
|---|---|---|
| 200 (OK) | Returned value for a parameter is a negative digit | This situation is OK. It may happen if a special value must be returned – for example, InLink Rank = -1 should be treated as “Unknown”. |
| 200 (OK) | Returned value for a parameter is zero | This situation is OK. It may happen if there’s no data for the target (e.g., no referring backlinks). |
| 244 | Results for huge websites like google.com or twitter.com are unavailable via API so far | The command does not support your target due to the huge amount of data it requires to process. |
| 400 | Incorrect order field {sort} {sort_order} | The sorting parameters provided are not valid. |
| 400 | Exceeded keywords size. Max keywords for one request: 10000 | The number of keywords in your request exceeds the maximum limit. |
| 400 | Invalid keywords | One or more keywords provided are invalid. |
| 400 | Invalid source | The regional database code is not supported. See the list of valid codes. |
| 400 | Invalid domain | The domain provided is not valid. |
| 400 | Incorrect order | The order parameter is incorrect. |
| 400 | Row limit exceeded | Your request exceeds the maximum number of rows that can be returned. |
| 400 | No token | API key is missing. Please review the authentication method used. |
| 400 (Bad Request) | YYYY=XXXX is not within the required bounds! | Please ensure all values you have passed as a target are valid. |
| 400 (Bad Request) | YYYY=XXXX is not within the required bounds! | A parameter value is outside the acceptable range. Refer to the specific endpoint documentation. |
| 400 (Bad Request) | Insufficient funds | Your credit balance is zero. Please replenish your credits to re-enable your API key. |
| 400 (Bad Request) | Unsupported ‘XXXXX’ format | A parameter format is unsupported. Refer to the endpoint documentation for valid values. |
| 400 (Bad Request) | The requested resource could not be found | The API endpoint or resource you are requesting does not exist. |
| 400 (Bad Request) | Supported modes are host (default), domain, or URL | The API key is invalid or disabled. Please verify your key. |
| 400 (Bad Request) | Parameter YYY is invalid | A parameter value is invalid. |
| 400 (Bad Request) | Unsupported ‘mode’ format | Supported modes are host (default), domain, or URL. |
| 400 (Bad Request) | Parameter YYY is missing | A mandatory parameter is missing from your request. |
| 403 | License expired | Your account’s license has expired. |
| 404 | Invalid source | The requested resource could not be found at this endpoint. |
| 405 (Method Not Allowed) | Method Not Allowed | You are using an HTTP method (e.g., GET, POST) that is not supported for this resource. |
| 406 (Not Acceptable) | Unsupported ‘output’ format | The server can’t produce a response in the requested format. Supported formats are json (default) and XML. |
| 429 (Too Many Requests) | Call rate limit reached | The server can’t produce a response in the requested format. Supported formats are json (default) and XML. |
| 500 (Internal Server Error) | Unexpected error. Please try again later. | An unexpected server-side error occurred. |
| 503 (Service unavailable) | System is busy. Please try again later. | The system is temporarily overloaded and can’t handle the request. |
