Management APIs
Account API

4min
Account API
﻿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
Curl
Node.js
Python
PHP
https://api.rainforestapi.com/account?api_key=demo
https://api.rainforestapi.com/account?api_key=demo
﻿
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:
JSON
{
  "request_info": {
    "success": true
  },
  "account_info": {
    "api_key": "API_KEY",
    "name": "John Smith",
    "email": "[email protected]",
    "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
        }
      }
    ]
  }
}
{
  "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
        }
      }
    ]
  }
}
﻿
﻿
Parameter	Required	Description
api_key	required	The API key for your account.
Updated 26 Aug 2024
Did this page help you?
List
Product Updates