Get Account Info

curl --request GET \
  --url https://scrapebadger.com/v1/account/me \
  --header 'x-api-key: <api-key>'

import requests

url = "https://scrapebadger.com/v1/account/me"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://scrapebadger.com/v1/account/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://scrapebadger.com/v1/account/me",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://scrapebadger.com/v1/account/me"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://scrapebadger.com/v1/account/me")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scrapebadger.com/v1/account/me")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "credits_balance": 50000,
  "subscription_credits_balance": 250000,
  "total_credits_balance": 300000,
  "tier": "pro",
  "rate_limit_per_minute": 1000,
  "subscription": {
    "plan_code": "growth",
    "plan_title": "Growth",
    "billing_cadence": "monthly",
    "status": "active",
    "current_period_start": "2026-05-01T00:00:00Z",
    "current_period_end": "2026-06-01T00:00:00Z",
    "cancel_at_period_end": false,
    "cancel_effective_at": null,
    "monthly_credits": 500000,
    "pending_plan_code": null,
    "pending_plan_title": null,
    "pending_change_effective_at": null
  }
}

GET

account

Get Account Info

curl --request GET \
  --url https://scrapebadger.com/v1/account/me \
  --header 'x-api-key: <api-key>'

import requests

url = "https://scrapebadger.com/v1/account/me"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://scrapebadger.com/v1/account/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://scrapebadger.com/v1/account/me",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://scrapebadger.com/v1/account/me"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://scrapebadger.com/v1/account/me")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scrapebadger.com/v1/account/me")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "credits_balance": 50000,
  "subscription_credits_balance": 250000,
  "total_credits_balance": 300000,
  "tier": "pro",
  "rate_limit_per_minute": 1000,
  "subscription": {
    "plan_code": "growth",
    "plan_title": "Growth",
    "billing_cadence": "monthly",
    "status": "active",
    "current_period_start": "2026-05-01T00:00:00Z",
    "current_period_end": "2026-06-01T00:00:00Z",
    "cancel_at_period_end": false,
    "cancel_effective_at": null,
    "monthly_credits": 500000,
    "pending_plan_code": null,
    "pending_plan_title": null,
    "pending_change_effective_at": null
  }
}

This endpoint is useful for monitoring your credit balance programmatically — e.g., before running a batch job or in a CI pipeline. It returns both PAYG and subscription credit balances, plus full subscription details if you’re on a plan. No credits are deducted.

Authorizations

x-api-key

string

header

required

Your ScrapeBadger API key. You can find this in your dashboard at https://scrapebadger.com/dashboard/api-keys

Response

Account info retrieved successfully

credits_balance

integer

PAYG (pay-as-you-go) credit balance — never expires

subscription_credits_balance

integer

Subscription wallet — current period's monthly allowance (0 if no subscription)

total_credits_balance

integer

Sum of PAYG + subscription credits

tier

enum<string>

Account tier (free, basic, pro, enterprise)

Available options:

free,

basic,

pro,

enterprise

rate_limit_per_minute

integer

Maximum API requests allowed per minute

subscription

object | null

Active subscription details, or null if PAYG-only

Show child attributes

Rate Limits