1. Home
  2. Docs
  3. API Docs
  4. Balance

Balance

It allows you to fetch information about your balance and subscriptions.

GET: https://api.app.outscraper.com/balance

Request parameters

apiKey (required)

API token from the profile page.


Example request:
https://api.app.outscraper.com/balance?apiKey=SECRET_API_KEY

Example response:
{
  "balance": 994.56,
  "usage_records": [
    {
      "total_usage": 8,
      "subscription_id": "XXXXXXXXXXXXXXXXXX",
      "subscription_created": 1592154436,
      "nickname": null,
      "usage_type": "metered",
      "interval": "month",
      "product_id": "XXXXXXXXXXXXXXXXXX",
      "product_name": "Google search",
      "product_link": "https://outscraper.com/google-search-api/",
      "product_unit_label": null
    },
    {
      "total_usage": 573,
      "subscription_id": "XXXXXXXXXXXXXXXXXX",
      "subscription_created": 1592032291,
      "nickname": "Monthly",
      "usage_type": "metered",
      "interval": "month",
      "product_id": "XXXXXXXXXXXXXXXXXX",
      "product_name": "Google Maps reviews",
      "product_link": "https://outscraper.com/google-maps-reviews-extractor/",
      "product_unit_label": "review"
    },
    {
      "total_usage": 2158,
      "subscription_id": "XXXXXXXXXXXXXXXXXX",
      "subscription_created": 1592032289,
      "nickname": "Monthly",
      "usage_type": "metered",
      "interval": "month",
      "product_id": "XXXXXXXXXXXXXXXXXX",
      "product_name": "Google Maps data",
      "product_link": "https://outscraper.com/google-maps-extractor/",
      "product_unit_label": "org"
    }
  ]
}