crawlbaseDocs
Se connecter

Account API

Accès programmatique à vos statistiques d'utilisation mensuelles : succès, échecs, montant dû, crédits restants et répartition par domaine.

Vue d'ensemble

L'Account API renvoie les statistiques d'utilisation mensuelles de vos produits Crawlbase. Utilisez-la pour surveiller votre consommation, créer des tableaux de bord internes ou déclencher des alertes lorsque vous approchez de votre limite de crédits.

Cette API est activement maintenue. Elle est regroupée sous « legacy » dans la navigation uniquement parce qu'il s'agit d'une forme d'endpoint plus ancienne : aucun remplacement n'est prévu.

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

Limite de débit : 1 requête toutes les 5 minutes

Cet endpoint agrège une grande quantité de données côté serveur. Mettez la réponse en cache : il n'est pas nécessaire de l'appeler plus fréquemment.

Démarrage rapide

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'))

Paramètres

token
stringrequis
Votre token Crawlbase.
product
stringrequis
Le produit dont récupérer l'utilisation. Au choix : crawling-api, crawler, smartproxy, scraper-api, leads-api, screenshot-api.
previous_month
booleanfalse
Lorsque défini à true, inclut les statistiques du mois précédent en plus du mois en cours pour comparer les tendances.

Champs de la réponse

totalSuccess
Nombre total de requêtes réussies ce mois-ci.
totalFailed
Nombre total de requêtes échouées ce mois-ci.
totalDue
Montant total dû en USD pour les requêtes réussies ce mois-ci.
remainingCredits
Crédits encore disponibles ce mois-ci. Renvoyé uniquement pour les produits par abonnement.
domainStats
Tableau des répartitions par domaine : domain, totalRequests, success, failure, successRate.

Exemples par produit

# 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'))