API

SE Ranking API Reference

Glossary
Regional database codes
SERP features
Error handling


Glossary

Find key terms used throughout this API documentation.

Anchor text

Clickable text in a hyperlink that points to another web resource.

Backlink

A reference to a target URL from a different domain via a link, redirect, redirect chain, or canonical link.

Destination page (URL)

The page that a link or redirect ultimately leads to.

Domain

The main part of a website address, such as example.com.

A score indicating a domain’s authority based on the number and weight of its incoming links, aggregated at the domain level (0–100).

Host

The full domain name including all subdomains, for example www.example.sub.domain.com.

A score indicating a page’s authority based on the number and weight of incoming links to that page (0–100).

Nofollow

A value assigned to the rel attribute in an <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 a destination URL.

Page (URL)

A web resource identified by a unique address that can be requested over a network.

Pay-Level Domain (PLD)

A subdomain of a public top-level domain, for which users usually pay for.

Referring domain

The domain of a page that links to your website.

Referring page (URL)

A specific page that sends users to your site via a link or redirect.

Subdomain

A domain that is part of a larger domain, such as sub.example.com (domain example.com).

Target

The entity (URL, domain, or subdomain) for which backlink data is requested.


Regional database codes

Use one of these ISO 3166-1 alpha-2 codes as the value of the source parameter to target a specific regional keyword database.

Note: Unsupported codes return a 400 Invalid source error.

A

afAfghanistan
alAlbania
dzAlgeria
asAmerican Samoa
aoAngola
aiAnguilla
agAntigua and Barbuda
arArgentina
amArmenia
awAruba
auAustralia
atAustria
azAzerbaijan

B

bsBahamas
bhBahrain
bdBangladesh
bbBarbados
byBelarus
beBelgium
bzBelize
bjBenin
btBhutan
boBolivia
baBosnia and Herzegovina
bwBotswana
brBrazil
vgBritish Virgin Islands
bnBrunei
bgBulgaria
bfBurkina Faso
biBurundi

C

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

D-F

dkDenmark
djDjibouti
dmDominica
doDominican Republic
ecEcuador
egEgypt
svEl Salvador
gqEquatorial Guinea
eeEstonia
etEthiopia
foFaroe Islands
fjFiji
fiFinland
frFrance
gfFrench Guiana
pfFrench Polynesia

G-L

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

M

mgMadagascar
mwMalawi
myMalaysia
mvMaldives
mlMali
mtMalta
mqMartinique
mrMauritania
muMauritius
ytMayotte
mxMexico
fmMicronesia
mdMoldova
mcMonaco
mnMongolia
meMontenegro
msMontserrat
maMorocco
mzMozambique
mmMyanmar

N-P

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

Q-T

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

U-Z

Note: Currently only uk is accepted for the United Kingdom. Support for gb is planned for a future update.
viU.S. Virgin Islands
ugUganda
uaUkraine
aeUnited Arab Emirates
ukUnited Kingdom
usUnited States
uyUruguay
uzUzbekistan
vuVanuatu
veVenezuela
vnVietnam
yeYemen
zmZambia
zwZimbabwe

SERP features

Use one of these codes as the value of the serp_features parameter to target keywords with specific SERP features.

Core Google results

reviewsReviews
sitelinksSitelinks
featured_snippetsFeatured Snippets
people_also_askPeople Also Ask
related_searchesRelated Searches
sgeAI overview
noNo
see_results_aboutSee Results About
refine_byRefine By
find_results_onFind Results On
researchResearch

Local and places

local_packLocal Pack
mapsMaps
locationLocation
popular_timesPopular Times
places_sites_productsPlaces Sites Products
gmbGmb
destinationDestination
things_to_doThings To Do
hotel_packHotel Pack

Media and visual

videoVideo
image_in_blockImage In Block
imagesImages
videos_blockVideos Block
carousel_resultsCarousel Results
top_storiesTop Stories
twitterTwitter
ampAmp
podcastsPodcasts

Knowledge and data

knowledge_graphKnowledge Graph
knowledge_cardKnowledge Card
faqFAQ
datasetsDatasets
stocks_blockStocks Block
math_solve_blockMath Solve Block

Shopping and commerce

shopping_resultsShopping Results
shopping_results_sideShopping Results Side
shopping_results_topShopping Results Top
shopping_results_main_blockShopping Results Main Block
marketplaceMarketplace
buying_guideBuying Guide
trip_cardsTrip Cards
flightsFlights

Jobs, events and community

Utilities

calculator Calculator
currency_converter Currency Converter
units_converter Units Converter
recipesRecipes

Ads

tadsTads
badsBads
sadsSads
madsMads

Error handling

Find general API status codes in the table below. Endpoint-specific errors are described within each endpoint’s documentation. When a request fails, an error description is included in the response body.

StatusCodeSummaryDetails
Success200Completed, valid responseRequest processed as expected.
Success200Value is negativeTreat as “Unknown” (e.g., InLink Rank = -1).
Success200Zero dataNo data available.
Special244Huge site unsupportedResults for very large domains like google.com or twitter.com are unavailable via API.
Client error400Incorrect orderSorting parameters {sort} or {sort_order} are invalid.
Client error400Invalid parameterValue outside allowed range.
Client error400Invalid sourceInvalid region code (see the list of valid codes).
Client error400Invalid domainBad domain format.
Client error400Invalid keywordsKeywords not valid.
Client error400Exceeded keywords sizeNumber of keywords in your request exceeds the maximum limit.
Client error400Too many queriesRequest exceeds the allowed number of queries for the endpoint.
Client error400Row limit exceededRequest exceeds the maximum number of rows allowed for the endpoint.
Client error400Missing parameterRequired field absent.
Client error400Unsupported modeMode must be host, domain, or URL.
Client error400Unsupported ‘XXXXX’ formatRequest format is not supported for this endpoint.
Client error400Insufficient fundsNo credits left.
Client error400Requested resource not foundEndpoint or resource doesn’t exist.
Authentication400No tokenMissing API key.
Authentication403License expiredSubscription expired.
Not found404Resource not foundRequested resource not found.
Method error405Method not allowedWrong HTTP method.
Not acceptable406Output format not supportedServer can’t produce the requested format (supported: json (default) and XML).
Rate limiting429Too many requestsRate limit reached.
Server error500Internal errorUnexpected server-side error.
Server error503Service unavailableSystem is temporarily overloaded.

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.