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.

TermDefinition
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.
DomainA network domain is an administrative grouping of multiple private computer networks or hosts within the same infrastructure under one domain name, e.g. domain.com. Optionally, a domain may have subdomains.
SubdomainA subdomain is a domain that is a part of another domain, e.g.: sub.domain.com is a subdomain of domain.com.
HostA 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 host name will be www.example.sub.domain.com.
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 which sends users to your website via links or redirects.
Destination Page (URL)A page a link or a redirect points to.
Referring domainA host name of the Referring Page (URL).
TargetAn entity for which you are retrieving backlinks. Can be determined at an exact URL, domain, or subdomain.
Anchor TextAnchor text is the clickable text in a hyperlink.
NofollowNofollow is 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 do not normally pass SEO weight to the destination URL.
InLink RankInLink Rank is the indicator of a page’s authority. It is based on the same algorithm as the original Google PageRank and is determined by the number and weight of incoming links to a page. InLink Rank is scored using a 0 to 100 logarithmic scale. The higher the number, the higher the page’s authority.
Domain InLink RankDomain InLink Rank is the indicator of a domain’s authority. Like InLink Rank, Domain InLink Rank can be used to assess 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.

CodeCountry / Region
afAfghanistan
alAlbania
dzAlgeria
asAmerican Samoa
aoAngola
aiAnguilla
agAntigua and Barbuda
arArgentina
amArmenia
awAruba
auAustralia
atAustria
azAzerbaijan
bsBahamas
bhBahrain
bdBangladesh
bbBarbados
byBelarus
beBelgium
bzBelize
bjBenin
btBhutan
boBolivia
baBosnia and Herzegovina
bwBotswana
brBrazil
vgBritish Virgin Islands
bnBrunei
bgBulgaria
bfBurkina Faso
biBurundi
cvCabo Verde
khCambodia
cmCameroon
caCanada
kyCayman Islands
cfCentral African Republic
tdChad
clChile
cnChina
coColombia
cdCongo (Democratic Republic)
cgCongo (Republic)
ckCook Islands
crCosta Rica
ciCôte d’Ivoire
hrCroatia
cuCuba
cyCyprus
czCzechia
dkDenmark
djDjibouti
dmDominica
doDominican Republic
ecEcuador
egEgypt
svEl Salvador
gqEquatorial Guinea
eeEstonia
etEthiopia
foFaroe Islands
fjFiji
fiFinland
frFrance
gfFrench Guiana
pfFrench Polynesia
gaGabon
gmGambia
geGeorgia
deGermany
ghGhana
giGibraltar
grGreece
glGreenland
gdGrenada
gpGuadeloupe
guGuam
gtGuatemala
ggGuernsey
gnGuinea
gyGuyana
htHaiti
hnHonduras
hkHong Kong
huHungary
isIceland
inIndia
idIndonesia
iqIraq
ieIreland
imIsle of Man
ilIsrael
itItaly
jmJamaica
jpJapan
jeJersey
joJordan
kzKazakhstan
keKenya
kiKiribati
kwKuwait
kgKyrgyzstan
laLaos
lvLatvia
lbLebanon
lsLesotho
lyLibya
liLiechtenstein
ltLithuania
luLuxembourg
mgMadagascar
mwMalawi
myMalaysia
mvMaldives
mlMali
mtMalta
mqMartinique
mrMauritania
muMauritius
ytMayotte
mxMexico
fmMicronesia
mdMoldova
mcMonaco
mnMongolia
meMontenegro
msMontserrat
maMorocco
mzMozambique
mmMyanmar
naNamibia
nrNauru
npNepal
nlNetherlands
ncNew Caledonia
nzNew Zealand
niNicaragua
neNiger
ngNigeria
nuNiue
mkNorth Macedonia
noNorway
omOman
pkPakistan
paPanama
pgPapua New Guinea
pyParaguay
pePeru
phPhilippines
pnPitcairn Islands
plPoland
ptPortugal
prPuerto Rico
qaQatar
reRéunion
roRomania
ruRussia
rwRwanda
shSaint Helena
knSaint Kitts and Nevis
lcSaint Lucia
vcSaint Vincent and the Grenadines
wsSamoa
smSan Marino
stSão Tomé and Príncipe
saSaudi Arabia
snSenegal
rsSerbia
scSeychelles
slSierra Leone
sgSingapore
skSlovakia
siSlovenia
sbSolomon Islands
soSomalia
zaSouth Africa
krSouth Korea
esSpain
lkSri Lanka
psState of Palestine
srSuriname
seSweden
chSwitzerland
twTaiwan
tjTajikistan
tzTanzania
thThailand
tlTimor-Leste
tgTogo
tkTokelau
toTonga
ttTrinidad and Tobago
tnTunisia
trTürkiye
tmTurkmenistan
viU.S. Virgin Islands
ugUganda
uaUkraine
aeUnited Arab Emirates
ukUnited Kingdom
usUnited States
uyUruguay
uzUzbekistan
vuVanuatu
veVenezuela
vnVietnam
yeYemen
zmZambia
zwZimbabwe

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.

CodeFeature
featured_snippetsFeatured Snippets
local_packLocal Pack
reviewsReviews
sitelinksSitelinks
videoVideo
carousel_resultsCarousel Results
top_storiesTop Stories
people_also_askPeople Also Ask
imagesImages
knowledge_graphKnowledge Graph
knowledge_cardKnowledge Card
tadsTads
badsBads
shopping_resultsShopping Results
twitterTwitter
ampAmp
noNo
hotel_packHotel Pack
researchResearch
jobsJobs
see_results_aboutSee Results About
flightsFlights
find_results_onFind Results On
eventsEvents
calculatorCalculator
mapsMaps
refine_byRefine By
digital_complaintsDigital Complaints
trip_cardsTrip Cards
recipesRecipes
appbar_eventsAppbar Events
sports_appSports App
podcastsPodcasts
gmbGmb
questionsQuestions
popular_timesPopular Times
locationLocation
destinationDestination
faqFaq
sgeSge
videos_blockVideos Block
related_searchesRelated Searches
image_in_blockImage In Block
marketplaceMarketplace
shopping_results_sideShopping Results Side
shopping_results_topShopping Results Top
shopping_results_main_blockShopping Results Main Block
datasetsDatasets
things_to_doThings To Do
places_sites_productsPlaces Sites Products
buying_guideBuying Guide
currency_converterCurrency Converter
units_converterUnits Converter
stocks_blockStocks Block
math_solve_blockMath Solve Block
discussions_and_forumsDiscussions And Forums
sadsSads
madsMads

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.

CodeError TextSolution / Explanation
200 (OK)Returned value for a parameter is a negative digitThis 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).
244Results 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.
400Incorrect order field {sort} {sort_order}The sorting parameters provided are not valid.
400Exceeded keywords size. Max keywords for one request: 10000The number of keywords in your request exceeds the maximum limit.
400Invalid keywordsOne or more keywords provided are invalid.
400Invalid sourceThe regional database code is not supported. See the list of valid codes.
400Invalid domainThe domain provided is not valid.
400Incorrect orderThe order parameter is incorrect.
400Row limit exceededYour request exceeds the maximum number of rows that can be returned.
400No tokenAPI key is missing. Please review the authentication method used.
400 (Bad Request)Invalid targetPlease ensure all values you have passed as a target are valid.
400 (Bad Request)YYYY=XXXX is not within 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)Authentication failed…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.
403License expiredYour account’s license has expired.
404Invalid sourceThe 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 cannot produce a response in the requested format. Supported formats are json (default) and xml.
429 (Too Many Requests)Call rate limit reached.You are making too many requests and have exceeded the rate limit for your API key.
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 cannot handle the request.

Learn how SE Ranking’s API can boost your SEO!

Hi! Meet our product expert, Alex.

He’ll walk you through the API and show you how to get the most out of it.

  • Enjoy a tailored demo on integrating rich, structured SEO data into your stack.
  • Pin down every tech detail live—auth, endpoints, rate limits, data formats.
  • Compare usage tiers and pricing so you can unlock maximum data value.

Request a free demo to see our tools and integrations in action

By clicking this button, you agree to SE Ranking’s Terms of Services and Privacy Policy.