API

SE Ranking API Reference

Glossary
Regional database codes
SERP features
Site Audit issue codes
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

Site Audit issue codes

Use these values with the Site Audit endpoints. Each audit report is organized into sections, and each section contains individual issue checks identified by a unique code.

Audit sections

Every audit report groups its checks into the following sections. Use the uid value when filtering or referencing a section programmatically.

UIDSection name
security_v2Security
crawling_v2Crawling & Indexing
redirects_v2Redirects
sitemaps_v2Sitemap
metatags_v2Meta Tags
content_v2Content
localizationLocalization
speed_performance_v2Speed & Performance
jsJavaScript
cssCSS
links_v2Links
mobileMobile Optimization
other_v2Other

Issue codes

Use one of these codes as the value of the code parameter in the Get pages by issue endpoint to retrieve all URLs affected by a specific issue.

Each code has a severity level: error, warning, or notice.

Security

CodeSeverityDescription
no_httpserrorNo HTTPS encryption
mixed_contenterrorMixed content
old_protocolerrorOutdated security protocol version
cert_nameerrorCertificate name mismatch
outdated_encryptionerrorOutdated encryption algorithm
sitemap_httpwarningHTTP URLs in XML sitemap
canonical_to_httpwarningrel=”canonical” from HTTPS to HTTP
cert_expwarningSecurity certificate expires soon

Crawling & Indexing

CodeSeverityDescription
http4xxerror4XX HTTP Status Codes
http5xxerror5XX HTTP Status Codes
timeouterrorTimed out
canonical4xxerrorCanonical URL with a 4XX Status Code
canonical5xxerrorCanonical URL with a 5XX Status Code
canonical3xxerrorCanonical URL with a 3XX Status Code
canonical_chainerrorCanonical chain
robots_has_too_many_redirectserrorRobots.txt either has too many redirects or a redirect loop
robots_not_accessibleerrorRobots.txt is not accessible
robots_has_errorserrorRobots.txt is not valid
blocked_by_noindexnoticeBlocked by noindex
both_noindexnoticeHTML and HTTP header contain noindex
blocked_by_xrobotsnoticeBlocked by X-Robots-Tag
blocked_by_nofollownoticeBlocked by nofollow
both_nofollownoticeHTML and HTTP header contain nofollow
blocked_by_robotsnoticeBlocked by robots.txt
no_robotsnoticeRobots.txt file not found
robots_disallow_crawlingnoticeRobots.txt is set to disallow crawling
long_urlnoticeURL too long

Redirects

CodeSeverityDescription
redirect45xxerrorRedirect to 4xx or 5xx
redirect_looperrorRedirect loop
redirect_chainerrorRedirect chain
meta_refresherrorMeta refresh redirect
redirect3xxwarning3XX HTTP status code
redirect_temporarywarning302, 303, 307 temporary redirects

Sitemap

CodeSeverityDescription
sitemap_4xxerror4XX pages in XML sitemap
sitemap5xxerror5XX pages in XML sitemap
sitemap_pages_timed_outerrorSitemap pages timed out
sitemap_noindexerrorNoindex pages in XML sitemap
sitemap_non_canonicalerrorNon-canonical pages in XML sitemap
sitemap_bigerrorXML sitemap is too large
sitemap_3xxwarning3XX redirects in XML sitemap
sitemap_missingwarningXML sitemap missing
sitemap_no_robotsnoticeXML sitemap not found in robots.txt file

Meta Tags

CodeSeverityDescription
title_missingerrorTitle tag missing
title_multipleerrorMultiple title tags
title_duplicateerrorURLs with duplicate page titles
description_missingwarningDescription missing
description_multiplewarningMultiple description tags
title_longnoticeTitle too long
title_shortnoticeTitle too short
description_duplicatenoticeDuplicate description
description_longnoticeDescription too long

Content

CodeSeverityDescription
duplicate_contenterrorDuplicate content
canonical_multipleerrorMultiple rel=”canonical”
no_trailing_slasheserrorNo trailing slashes
double_slash_urlerrorURLs with double slash
images3xxerror3XX images
images4xxerror4XX images (Not Found)
images5xxerror5XX images (Loading Failed)
no_www_redirectwarningNo WWW redirect
h1_missingwarningH1 tag missing
h1_emptywarningH1 tag empty
image_no_altwarningAlt text missing
image_bigwarningImage too big
h1_multiplenoticeMultiple H1 tags
h1_duplicatenoticeDuplicate H1
same_title_h1noticeIdentical Title and H1 tags
h1_longnoticeH1 tag too long

Localization

CodeSeverityDescription
hreflang_invaliderrorInvalid language code
hreflang_duplicateserrorLanguage duplicates in hreflang
hreflang_non_canonicalerrorHreflang to non-canonical
hreflang345xxerrorHreflang to 3XX, 4XX or 5XX
hreflang_returnerrorConfirmation (return) links missing on hreflang pages
hreflang_no_selferrorHreflang page doesn’t link out to itself
hreflang_differentwarningHreflang and HTML lang do not match
hreflang_xdefaultwarningX-default hreflang attribute missing
hreflang_multiplenoticeMultiple language codes for one page
invalid_langnoticeInvalid HTML lang
lang_missingnoticeHTML lang missing

Speed & Performance

CodeSeverityDescription
loading_speedwarningSlow page loading speed
lighthouse_speed_indexwarningSpeed Index
chrome_ux_lcpwarningLargest Contentful Paint (LCP) in real-world conditions
lighthouse_lcpwarningLargest Contentful Paint (LCP) in a lab environment
chrome_ux_clswarningCumulative Layout Shift (CLS) in real-world conditions
lighthouse_clswarningCumulative Layout Shift (CLS) in a lab environment
chrome_ux_fcpwarningFirst Contentful Paint (FCP) in real-world conditions
lighthouse_fcpwarningFirst Contentful Paint (FCP) in a lab environment
chrome_ux_inpwarningInteraction to Next Paint (INP) in real-world conditions
lighthouse_ttiwarningTime to Interactive (TTI)
lighthouse_tbtwarningTotal Blocking Time (TBT)
too_bigwarningHTML size too big
uncompressednoticeUncompressed content

JavaScript

CodeSeverityDescription
js45xxerror4XX or 5XX JavaScript file
js3xxerror3XX JavaScript file
extjs345xxerrorExternal JavaScript with 3XX, 4XX or 5XX
js_bignoticeJavaScript too big
js_uncompressednoticeJavaScript not compressed
js_not_minnoticeJavaScript not minified
js_not_cachednoticeJavaScript not cached
js_manynoticeToo many JavaScript files

CSS

CodeSeverityDescription
css45xxerror4XX or 5XX CSS file
extcss345xxerrorExternal CSS files with 3XX, 4XX or 5XX
css3xxwarning3XX CSS file
css_bignoticeCSS too big
css_uncompressednoticeCSS not compressed
css_not_minnoticeCSS not minified
css_not_cachednoticeCSS not cached
css_manynoticeToo many CSS files

Links

CodeSeverityDescription
no_inlinkserrorNo inbound links
links3xxwarningInternal links to 3XX redirect pages
extlinks4xxwarningExternal links to 4XX
extlinks5xxwarningExternal links to 5XX
less_inlinknoticeOne inbound internal link
links_nofollownoticeNofollow internal links
links_no_anchornoticeInternal links missing anchor
extlinks3xxnoticeExternal links to 3XX
extlinks_timeoutnoticeExternal links timed out
extlinks_nofollownoticeNofollow external links
extlinks_no_anchornoticeExternal links missing anchor

Mobile Optimization

CodeSeverityDescription
viewport_missingerrorViewport meta tag missing
viewport_device_widthwarningFixed width value in viewport meta tag

Other

CodeSeverityDescription
no_faviconwarningFavicon missing
pluginswarningUse of incompatible plugins
twitter_missingnoticeX (ex-Twitter) Card tag missing

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 experts!

One of them will 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.