Management APIs
Account API
4min
account api get get /account the value serp account api allows you to check the number of searches made in the current month there is no charge for calls made to the account api the account api also shows current platform status http https //api valueserp com/account?api key=demo$ curl get https //api valueserp com/account \\ d api key="demo"const axios = require('axios'); // set up the request parameters const params = { api key "demo" } // make the http get request to value serp axios get('https //api valueserp com/account', { params }) then(response => { // print the json response from value serp console log(json stringify(response data, 0, 2)); }) catch(error => { // catch and print the error console log(error); })import requests import json \# set up the request parameters params = { 'api key' 'demo' } \# make the http get request to value serp api result = requests get('https //api valueserp com/account', params) \# print the json response from value serp print(json dumps(api result json()))# set up the request parameters $querystring = http build query(\[ 'api key' => 'demo' ]); \# make the http get request to value serp $ch = curl init(sprintf('%s?%s', 'https //api valueserp com/account', $querystring)); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $api result = curl exec($ch); curl close($ch); \# print the json response from value serp echo $api result; to view value serp json results clearly in your browser we recommend these extensions for chrome and firefox parameters the account api takes a single parameter, the api key to retrieve account information from parameter required description api key required the api key for your account response the account api returns structured json showing your account details and platform status the usage history property contains detailed credit usage history for the past 3 months { "request info" { "success" true }, "account info" { "api key" "api key", "name" "john smith", "email" "john smith\@example com", "plan" "plan name", "timezone" "(utc+01 00) sarajevo, skopje, warsaw, zagreb", "destinations used" 0, "destinations limit" 50, "destinations available" 50, "batches used" 0, "batches limit" 10000, "batches available" 10000, "topup credits remaining" 99, "rate limit per minute" 2500, "auto top up enabled" true, "monthly credits limit" 15000, "monthly credits remaining" 14885, "monthly credits reset at" "2020 01 01t00 00 00 000z", "status" \[ { "component" "component name", "status" "operational" } ], "usage history" \[ { "month" "january", "year" 2020, "month number" 1, "is current month" true, "credits total for month" 115, "credits total per day" { "1" 115, "2" 0, "3" 0, "4" 0, "5" 0, "6" 0 } } ] } }