crawlbaseДокументация
Войти

Account API

Программный доступ к ежемесячной статистике использования: успешные запросы, ошибки, сумма к оплате, оставшиеся кредиты и разбивка по доменам.

Обзор

Account API возвращает ежемесячную статистику использования продуктов Crawlbase. Используйте его для мониторинга потребления, создания внутренних дашбордов или оповещений о приближении к лимиту кредитов.

Этот API активно поддерживается. В навигации он сгруппирован в разделе «legacy» только потому, что это endpoint более старого формата - замены не планируется.

Endpoint:https://api.crawlbase.com/account

Лимит запросов: 1 запрос в 5 минут

Этот endpoint агрегирует большой объём данных на стороне сервера. Кэшируйте ответ - вызывать его чаще нет необходимости.

Быстрый старт

curl 'https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api'
import requests

res = requests.get('https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api')
print(res.json())
const res = await fetch('https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api');
console.log(await res.json());
require 'net/http'

puts Net::HTTP.get(URI('https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api'))

Параметры

token
stringобязательный
Ваш токен Crawlbase.
product
stringобязательный
Использование какого продукта запрашивается. Одно из значений: crawling-api, crawler, smartproxy, scraper-api, leads-api, screenshot-api.
previous_month
booleanfalse
Если true, включает статистику за предыдущий месяц вместе с текущим для сравнения трендов.

Поля ответа

totalSuccess
Всего успешных запросов за этот месяц.
totalFailed
Всего неуспешных запросов за этот месяц.
totalDue
Общая сумма к оплате в USD за успешные запросы этого месяца.
remainingCredits
Кредиты, доступные в этом месяце. Возвращается только для продуктов с подпиской.
domainStats
Массив с разбивкой по доменам: domain, totalRequests, success, failure, successRate.

Примеры по продуктам

# Crawling API
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api"

# Enterprise Crawler
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawler"

# Smart AI Proxy
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=smartproxy"

# Scraper API (legacy)
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=scraper-api"

# Leads API (legacy)
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=leads-api"

# Screenshots API (legacy)
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=screenshot-api"

# With previous month for trend comparison
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api&previous_month=true"
import requests

products = ['crawling-api', 'crawler', 'smartproxy', 'scraper-api', 'leads-api', 'screenshot-api']
for product in products:
    res = requests.get(
        'https://api.crawlbase.com/account',
        params={'token': 'YOUR_TOKEN', 'product': product},
    )
    print(product, res.json())

# With previous month for trend comparison
res = requests.get('https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api&previous_month=true')
print(res.json())
const products = ['crawling-api', 'crawler', 'smartproxy', 'scraper-api', 'leads-api', 'screenshot-api'];
for (const product of products) {
  const res = await fetch(`https://api.crawlbase.com/account?token=YOUR_TOKEN&product=${product}`);
  console.log(product, await res.json());
}

// With previous month for trend comparison
const res = await fetch('https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api&previous_month=true');
console.log(await res.json());
require 'net/http'

%w[crawling-api crawler smartproxy scraper-api leads-api screenshot-api].each do |product|
  uri = URI('https://api.crawlbase.com/account')
  uri.query = URI.encode_www_form(token: 'YOUR_TOKEN', product: product)
  puts product, Net::HTTP.get(uri)
end

# With previous month for trend comparison
puts Net::HTTP.get(URI('https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api&previous_month=true'))