API

API / Data API / SE Ranking API Reference

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.

Domain InLink Rank

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.

InLink Rank

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

`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

B

`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

C

`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

D-F

`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

G-L

`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

M

`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

N-P

`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

Q-T

`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

U-Z

Note: Currently only uk is accepted for the United Kingdom. Support for gb is planned for a future update.

`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

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

`reviews`	Reviews
`sitelinks`	Sitelinks
`featured_snippets`	Featured Snippets
`people_also_ask`	People Also Ask
`related_searches`	Related Searches
`sge`	AI overview
`no`	No
`see_results_about`	See Results About
`refine_by`	Refine By
`find_results_on`	Find Results On
`research`	Research

Local and places

`local_pack`	Local Pack
`maps`	Maps
`location`	Location
`popular_times`	Popular Times
`places_sites_products`	Places Sites Products
`gmb`	Gmb
`destination`	Destination
`things_to_do`	Things To Do
`hotel_pack`	Hotel Pack

Media and visual

`video`	Video
`image_in_block`	Image In Block
`images`	Images
`videos_block`	Videos Block
`carousel_results`	Carousel Results
`top_stories`	Top Stories
`twitter`	Twitter
`amp`	Amp
`podcasts`	Podcasts

Knowledge and data

`knowledge_graph`	Knowledge Graph
`knowledge_card`	Knowledge Card
`faq`	FAQ
`datasets`	Datasets
`stocks_block`	Stocks Block
`math_solve_block`	Math Solve Block

Shopping and commerce

`shopping_results`	Shopping Results
`shopping_results_side`	Shopping Results Side
`shopping_results_top`	Shopping Results Top
`shopping_results_main_block`	Shopping Results Main Block
`marketplace`	Marketplace
`buying_guide`	Buying Guide
`trip_cards`	Trip Cards
`flights`	Flights

Jobs, events and community

`jobs`	Jobs
`events`	Events
`appbar_events`	Appbar Events
`sports_app`	Sports App
`questions`	Questions
`discussions_and_forums`	Discussions And Forums
`digital_complaints`	Digital Complaints

Utilities

`calculator`	Calculator
`currency_converter`	Currency Converter
`units_converter`	Units Converter
`recipes`	Recipes

`tads`	Tads
`bads`	Bads
`sads`	Sads
`mads`	Mads

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.

UID	Section name
`security_v2`	Security
`crawling_v2`	Crawling & Indexing
`redirects_v2`	Redirects
`sitemaps_v2`	Sitemap
`metatags_v2`	Meta Tags
`content_v2`	Content
`localization`	Localization
`speed_performance_v2`	Speed & Performance
`js`	JavaScript
`css`	CSS
`links_v2`	Links
`mobile`	Mobile Optimization
`other_v2`	Other

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

Code	Severity	Description
`no_https`	error	No HTTPS encryption
`mixed_content`	error	Mixed content
`old_protocol`	error	Outdated security protocol version
`cert_name`	error	Certificate name mismatch
`outdated_encryption`	error	Outdated encryption algorithm
`sitemap_http`	warning	HTTP URLs in XML sitemap
`canonical_to_http`	warning	rel=”canonical” from HTTPS to HTTP
`cert_exp`	warning	Security certificate expires soon

Crawling & Indexing

Code	Severity	Description
`http4xx`	error	4XX HTTP Status Codes
`http5xx`	error	5XX HTTP Status Codes
`timeout`	error	Timed out
`canonical4xx`	error	Canonical URL with a 4XX Status Code
`canonical5xx`	error	Canonical URL with a 5XX Status Code
`canonical3xx`	error	Canonical URL with a 3XX Status Code
`canonical_chain`	error	Canonical chain
`robots_has_too_many_redirects`	error	Robots.txt either has too many redirects or a redirect loop
`robots_not_accessible`	error	Robots.txt is not accessible
`robots_has_errors`	error	Robots.txt is not valid
`blocked_by_noindex`	notice	Blocked by noindex
`both_noindex`	notice	HTML and HTTP header contain noindex
`blocked_by_xrobots`	notice	Blocked by X-Robots-Tag
`blocked_by_nofollow`	notice	Blocked by nofollow
`both_nofollow`	notice	HTML and HTTP header contain nofollow
`blocked_by_robots`	notice	Blocked by robots.txt
`no_robots`	notice	Robots.txt file not found
`robots_disallow_crawling`	notice	Robots.txt is set to disallow crawling
`long_url`	notice	URL too long

Redirects

Code	Severity	Description
`redirect45xx`	error	Redirect to 4xx or 5xx
`redirect_loop`	error	Redirect loop
`redirect_chain`	error	Redirect chain
`meta_refresh`	error	Meta refresh redirect
`redirect3xx`	warning	3XX HTTP status code
`redirect_temporary`	warning	302, 303, 307 temporary redirects

Sitemap

Code	Severity	Description
`sitemap_4xx`	error	4XX pages in XML sitemap
`sitemap5xx`	error	5XX pages in XML sitemap
`sitemap_pages_timed_out`	error	Sitemap pages timed out
`sitemap_noindex`	error	Noindex pages in XML sitemap
`sitemap_non_canonical`	error	Non-canonical pages in XML sitemap
`sitemap_big`	error	XML sitemap is too large
`sitemap_3xx`	warning	3XX redirects in XML sitemap
`sitemap_missing`	warning	XML sitemap missing
`sitemap_no_robots`	notice	XML sitemap not found in robots.txt file

Meta Tags

Code	Severity	Description
`title_missing`	error	Title tag missing
`title_multiple`	error	Multiple title tags
`title_duplicate`	error	URLs with duplicate page titles
`description_missing`	warning	Description missing
`description_multiple`	warning	Multiple description tags
`title_long`	notice	Title too long
`title_short`	notice	Title too short
`description_duplicate`	notice	Duplicate description
`description_long`	notice	Description too long

Content

Code	Severity	Description
`duplicate_content`	error	Duplicate content
`canonical_multiple`	error	Multiple rel=”canonical”
`no_trailing_slashes`	error	No trailing slashes
`double_slash_url`	error	URLs with double slash
`images3xx`	error	3XX images
`images4xx`	error	4XX images (Not Found)
`images5xx`	error	5XX images (Loading Failed)
`no_www_redirect`	warning	No WWW redirect
`h1_missing`	warning	H1 tag missing
`h1_empty`	warning	H1 tag empty
`image_no_alt`	warning	Alt text missing
`image_big`	warning	Image too big
`h1_multiple`	notice	Multiple H1 tags
`h1_duplicate`	notice	Duplicate H1
`same_title_h1`	notice	Identical Title and H1 tags
`h1_long`	notice	H1 tag too long

Localization

Code	Severity	Description
`hreflang_invalid`	error	Invalid language code
`hreflang_duplicates`	error	Language duplicates in hreflang
`hreflang_non_canonical`	error	Hreflang to non-canonical
`hreflang345xx`	error	Hreflang to 3XX, 4XX or 5XX
`hreflang_return`	error	Confirmation (return) links missing on hreflang pages
`hreflang_no_self`	error	Hreflang page doesn’t link out to itself
`hreflang_different`	warning	Hreflang and HTML lang do not match
`hreflang_xdefault`	warning	X-default hreflang attribute missing
`hreflang_multiple`	notice	Multiple language codes for one page
`invalid_lang`	notice	Invalid HTML lang
`lang_missing`	notice	HTML lang missing

Speed & Performance

Code	Severity	Description
`loading_speed`	warning	Slow page loading speed
`lighthouse_speed_index`	warning	Speed Index
`chrome_ux_lcp`	warning	Largest Contentful Paint (LCP) in real-world conditions
`lighthouse_lcp`	warning	Largest Contentful Paint (LCP) in a lab environment
`chrome_ux_cls`	warning	Cumulative Layout Shift (CLS) in real-world conditions
`lighthouse_cls`	warning	Cumulative Layout Shift (CLS) in a lab environment
`chrome_ux_fcp`	warning	First Contentful Paint (FCP) in real-world conditions
`lighthouse_fcp`	warning	First Contentful Paint (FCP) in a lab environment
`chrome_ux_inp`	warning	Interaction to Next Paint (INP) in real-world conditions
`lighthouse_tti`	warning	Time to Interactive (TTI)
`lighthouse_tbt`	warning	Total Blocking Time (TBT)
`too_big`	warning	HTML size too big
`uncompressed`	notice	Uncompressed content

JavaScript

Code	Severity	Description
`js45xx`	error	4XX or 5XX JavaScript file
`js3xx`	error	3XX JavaScript file
`extjs345xx`	error	External JavaScript with 3XX, 4XX or 5XX
`js_big`	notice	JavaScript too big
`js_uncompressed`	notice	JavaScript not compressed
`js_not_min`	notice	JavaScript not minified
`js_not_cached`	notice	JavaScript not cached
`js_many`	notice	Too many JavaScript files

CSS

Code	Severity	Description
`css45xx`	error	4XX or 5XX CSS file
`extcss345xx`	error	External CSS files with 3XX, 4XX or 5XX
`css3xx`	warning	3XX CSS file
`css_big`	notice	CSS too big
`css_uncompressed`	notice	CSS not compressed
`css_not_min`	notice	CSS not minified
`css_not_cached`	notice	CSS not cached
`css_many`	notice	Too many CSS files

Links

Code	Severity	Description
`no_inlinks`	error	No inbound links
`links3xx`	warning	Internal links to 3XX redirect pages
`extlinks4xx`	warning	External links to 4XX
`extlinks5xx`	warning	External links to 5XX
`less_inlink`	notice	One inbound internal link
`links_nofollow`	notice	Nofollow internal links
`links_no_anchor`	notice	Internal links missing anchor
`extlinks3xx`	notice	External links to 3XX
`extlinks_timeout`	notice	External links timed out
`extlinks_nofollow`	notice	Nofollow external links
`extlinks_no_anchor`	notice	External links missing anchor

Mobile Optimization

Code	Severity	Description
`viewport_missing`	error	Viewport meta tag missing
`viewport_device_width`	warning	Fixed width value in viewport meta tag

Other

Code	Severity	Description
`no_favicon`	warning	Favicon missing
`plugins`	warning	Use of incompatible plugins
`twitter_missing`	notice	X (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.

Status	Code	Summary	Details
Success	`200`	Completed, valid response	Request processed as expected.
Success	`200`	Value is negative	Treat as “Unknown” (e.g., InLink Rank = -1).
Success	`200`	Zero data	No data available.
Special	`244`	Huge site unsupported	Results for very large domains like google.com or twitter.com are unavailable via API.
Client error	`400`	Incorrect order	Sorting parameters {sort} or {sort_order} are invalid.
Client error	`400`	Invalid parameter	Value outside allowed range.
Client error	`400`	Invalid source	Invalid region code (see the list of valid codes).
Client error	`400`	Invalid domain	Bad domain format.
Client error	`400`	Invalid keywords	Keywords not valid.
Client error	`400`	Exceeded keywords size	Number of keywords in your request exceeds the maximum limit.
Client error	`400`	Too many queries	Request exceeds the allowed number of queries for the endpoint.
Client error	`400`	Row limit exceeded	Request exceeds the maximum number of rows allowed for the endpoint.
Client error	`400`	Missing parameter	Required field absent.
Client error	`400`	Unsupported mode	Mode must be host, domain, or URL.
Client error	`400`	Unsupported ‘XXXXX’ format	Request format is not supported for this endpoint.
Client error	`400`	Insufficient funds	No credits left.
Client error	`400`	Requested resource not found	Endpoint or resource doesn’t exist.
Authentication	`400`	No token	Missing API key.
Authentication	`403`	License expired	Subscription expired.
Not found	`404`	Resource not found	Requested resource not found.
Method error	`405`	Method not allowed	Wrong HTTP method.
Not acceptable	`40`6	Output format not supported	Server can’t produce the requested format (supported: json (default) and XML).
Rate limiting	`429`	Too many requests	Rate limit reached.
Server error	`500`	Internal error	Unexpected server-side error.
Server error	`503`	Service unavailable	System is temporarily overloaded.