Management APIs
Account API
4min
account api get get /account the rainforest api account api allows you to check the number of requests 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 rainforestapi com/account?api key=demo$ curl get https //api rainforestapi 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 rainforest api axios get('https //api rainforestapi com/account', { params }) then(response => { // print the json response from rainforest api 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 rainforest api api result = requests get('https //api rainforestapi com/account', params) \# print the json response from rainforest api print(json dumps(api result json()))\<?php \# set up the request parameters $querystring = http build query(\[ 'api key' => 'demo' ]); \# make the http get request to rainforest api $ch = curl init(sprintf('%s?%s', 'https //api rainforestapi 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 rainforest api echo $api result; ?> to view rainforest api 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", "credits used" 115, "credits limit" 15000, "credits remaining" 14885, "credits reset at" "2020 01 01t00 00 00 000z", "destinations used" 0, "destinations limit" 50, "destinations available" 50, "collections used" 0, "collections limit" 10000, "collections available" 10000, "account balance usd" 88 5, "account balance message" "your account balance is used to pay any overage charges (to avoid multiple small transactions being made to your payment card) you can top up your account balance on the account page of the dashboard your account balance is not used for your monthly plan payment ", "overage allowed" true, "overage enabled" true, "overage limit" 5000000, "zipcodes used" 2, "zipcodes limit" 100, "zipcodes available" 98, "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 } } ] } }