Request parameters
Additional software is required to send requests through the Serpstat API. All you need to use are POST requests.
API endpoint
https://api.serpstat.com/v4/?token={token}
Request parameters:
{token} - the token that you created in the "Profile" section.
Request body:
{
"id": 1,
"method": "{method}",
"params": {
"domains": ["{domain}"],
"se": "{se}"
}
}
Request body parameters:
- {method} - defines the type of information that is inserted in the report. For a list of API methods, see section 2 of this tutorial.
- {domain} - the address of the domain you are interested in.
- {se} - database. Choose one of the following options:
Google:
g_af — Google Afghanistan
g_al — Google Albania
g_dz — Google Algeria
g_as — Google American Samoa
g_ad — Google Andorra
g_ao — Google Angola
g_ai — Google Anguilla
g_ag — Google Antigua and Barbuda
g_ar — Google Argentina
g_am — Google Armenia
g_aw — Google Aruba
g_au — Google Australia
g_at — Google Austria
g_az — Google Azerbaijan
g_bh — Google Bahrain
g_bd — Google Bangladesh
g_bb — Google Barbados
g_by — Google Belarus
g_be — Google Belgium
g_bz — Google Belize
g_bj — Google Benin
g_bm — Google Bermuda
g_bt — Google Bhutan
g_bo — Google Bolivia
g_ba — Google Bosnia and Herzegovina
g_bw — Google Botswana
g_br — Google Brazil
g_io — Google British Indian Ocean Territory
g_vg — Google British Virgin Islands
g_bn — Google Brunei
g_bg — Google Bulgaria
g_bf — Google Burkina Faso
g_bi — Google Burundi
g_kh — Google Cambodia
g_cm — Google Cameroon
g_ca — Google Canada
g_cv — Google Cape Verde
g_ky — Google Cayman Islands
g_cf — Google Central African Republic
g_td — Google Chad
g_cl — Google Chile
g_cn — Google China
g_cx — Google Christmas Island
g_сс — Google Cocos (Keeling) Islands
g_co — Google Colombia
g_km — Google Comoros
g_ck — Google Cook Islands
g_cr — Google Costa Rica
g_ci — Google Cote d'Ivoire
g_hr — Google Croatia
g_cw — Google Curacao
g_cy — Google Cyprus
g_cz — Google Czech Republic
g_cd — Google Democratic Republic of the Congo
g_dk — Google Denmark
g_dj — Google Djibouti
g_dm — Google Dominica
g_do — Google Dominican Republic
g_ec — Google Ecuador
g_eg — Google Egypt
g_sv — Google El Salvador
g_gq — Google Equatorial Guinea
g_er — Google Eritrea
g_ee — Google Estonia
g_et — Google Ethiopia
g_fk — Google Falkland Islands (Islas Malvinas)
g_fo — Google Faroe Islands
g_fm — Google Federated States of Micronesia
g_fj — Google Fiji
g_fi — Google Finland
g_fr — Google France
g_gf — Google French Guiana
g_pf — Google French Polynesia
g_ga — Google Gabon
g_ge — Google Georgia
g_de — Google Germany
g_gh — Google Ghana
g_gi — Google Gibraltar
g_gr — Google Greece
g_gl — Google Greenland
g_gd — Google Grenada
g_gp — Google Guadeloupe
g_gu — Google Guam
g_gt — Google Guatemala
g_gg — Google Guernsey
g_gn — Google Guinea
g_gw — Google Guinea-Bissau
g_gy — Google Guyana
g_ht — Google Haiti
g_hn — Google Honduras
g_hk — Google Hong Kong
g_hu — Google Hungary
g_is — Google Iceland
g_in — Google India
g_id — Google Indonesia
g_iq — Google Iraq
g_ie — Google Ireland
g_im — Google Isle of Man
g_il — Google Israel
g_it — Google Italy
g_jm — Google Jamaica
g_jp — Google Japan
g_je — Google Jersey
g_jo — Google Jordan
g_kz — Google Kazakhstan
g_ke — Google Kenya
g_ki — Google Kiribati
g_kw — Google Kuwait
g_kg — Google Kyrgyzstan
g_la — Google Laos
g_lv — Google Latvia
g_lb — Google Lebanon
g_ls — Google Lesotho
g_lr — Google Liberia
g_ly — Google Libya
g_li — Google Liechtenstein
g_lt — Google Lithuania
g_lu — Google Luxembourg
g_mo — Google Macau
g_mk — Google Macedonia (FYROM)
g_mg — Google Madagascar
g_mw — Google Malawi
g_my — Google Malaysia
g_mv — Google Maldives
g_ml — Google Mali
g_mt — Google Malta
g_mh — Google Marshall Islands
g_mq — Google Martinique
g_mr — Google Mauritania
g_mu — Google Mauritius
g_yt — Google Mayotte
g_mx — Google Mexico
g_md — Google Moldova
g_mc — Google Monaco
g_mn — Google Mongolia
g_me — Google Montenegro
g_ms — Google Montserrat
g_ma — Google Morocco
g_mz — Google Mozambique
g_mm — Google Myanmar (Burma)
g_na — Google Namibia
g_nr — Google Nauru
g_np — Google Nepal
g_nl — Google Netherlands
g_nc — Google New Caledonia
g_nz — Google New Zealand
g_ni — Google Nicaragua
g_ne — Google Niger
g_ng — Google Nigeria
g_nu — Google Niue
g_nf — Google Norfolk Island
g_mp — Google Northern Mariana Islands
g_no — Google Norway
g_om — Google Oman
g_pk — Google Pakistan
g_pw — Google Palau
g_ps — Google Palestine
g_pa — Google Panama
g_pg — Google Papua New Guinea
g_py — Google Paraguay
g_pe — Google Peru
g_ph — Google Philippines
g_pn — Google Pitcairn Islands
g_pl — Google Poland
g_pt — Google Portugal
g_pr — Google Puerto Rico
g_qa — Google Qatar
g_cg — Google Republic of the Congo
g_re — Google Reunion
g_ro — Google Romania
g_ru — Google Russia
g_rw — Google Rwanda
g_sh — Google Saint Helena, Ascension and Tristan da Cunha
g_kn — Google Saint Kitts and Nevis
g_lc — Google Saint Lucia
g_pm — Google Saint Pierre and Miquelon
g_vc — Google Saint Vincent and Grenadines
g_ws — Google Samoa
g_sm — Google San Marino
g_st — Google Sao Tome and Principe
g_sa — Google Saudi Arabia
g_sn — Google Senegal
g_rs — Google Serbia
g_sc — Google Seychelles
g_sl — Google Sierra Leone
g_sg — Google Singapore
g_sx — Google Sint Maarten
g_sk — Google Slovakia
g_si — Google Slovenia
g_sb — Google Solomon Islands
g_so — Google Somalia
g_za — Google South Africa
g_kr — Google South Korea
g_es — Google Spain
g_lk — Google Sri Lanka
g_sr — Google Suriname
g_sz — Google Swaziland
g_se — Google Sweden
g_ch — Google Switzerland
g_tw — Google Taiwan
g_tj — Google Tajikistan
g_tz — Google Tanzania
g_th — Google Thailand
g_bs — Google The Bahamas
g_gm — Google The Gambia
g_tl — Google Timor-Leste
g_tg — Google Togo
g_tk — Google Tokelau
g_to — Google Tonga
g_tt — Google Trinidad and Tobago
g_tn — Google Tunisia
g_tr — Google Turkey
g_tm — Google Turkmenistan
g_tc — Google Turks and Caicos Islands
g_tv — Google Tuvalu
g_vi — Google U.S. Virgin Islands
g_ug — Google Uganda
g_ua — Google Ukraine
g_ae — Google United Arab Emirates
g_uk — Google United Kingdom
g_us — Google United States
g_uy — Google Uruguay
g_uz — Google Uzbekistan
g_vu — Google Vanuatu
g_va — Google Vatican City
g_ve — Google Venezuela
g_vn — Google Vietnam
g_wf — Google Wallis and Futuna
g_ye — Google Yemen
g_zm — Google Zambia
g_zw — Google Zimbabwe
Bing:
bing_us — Bing USA
Sample request:
https://api.serpstat.com/v4/?token=1234567890
{
"id": 1,
"method": "SerpstatDomainProcedure.getDomainsInfo",
"params": {
"domains": ["google.com"],
"se": "g_us"
}
}
For a keyword:
api.serpstat.com/v4/?token={token}
Request parameters:
{token} - the token that you created in the "Profile" section.
Request body:
{
"id": 1,
"method": "{method}",
"params": {
"keywords": ["{keywords}"],
"se": "{se}"
}
}
Request body parameters:
{method} - defines the type of information that is inserted in the report. For a list of API methods, see section 2 of this tutorial.
{keywords} - keyword.
{se} - database. Choose one of the options above.
Request example:
https://api.serpstat.com/v4/?token=1234567890
Example request body:
{
"id": 1,
"method": "SerpstatKeywordProcedure.getKeywordsInfo",
"params": {
"keywords": ["rent a car"],
"se": "g_us"
}
}
The next step is to decide what information you want to get and choose one of our API reports.