API Usage
Récupérez les statistiques d'utilisation en temps réel et le solde de crédits de votre compte Piloterr.
Vue d'ensemble de l'endpoint
Documentation détaillée, tarifs et exemples d'utilisation.
PrésentationLink to Présentation
L'endpoint Usage retourne un aperçu complet de la consommation de crédits, du statut d'abonnement, des limites de débit et des métadonnées de clé API de votre compte Piloterr. Utilisez-le pour surveiller votre consommation de manière programmatique et déclencher des alertes ou des recharges avant d'épuiser vos crédits.
Démarrage rapideLink to Démarrage rapide
GET https://api.piloterr.com/v2/usage
ParamètresLink to Paramètres
Cet endpoint ne nécessite aucun paramètre de requête. L'authentification s'effectue via l'en-tête x-api-key.
| Paramètre | Type | Requis | Description |
|---|---|---|---|
x-api-key |
string | oui | Votre clé API privée Piloterr |
Champs de réponseLink to Champs de réponse
| Champ | Type | Description |
|---|---|---|
remaining |
number | Crédits restants sur le compte |
total_used |
number | Total des crédits consommés depuis la création du compte |
renewal_date |
string | null | Date du prochain renouvellement d'abonnement (ISO 8601) |
period.start |
string | Début de la période de facturation en cours |
period.end |
string | Fin de la période de facturation en cours |
subscription.used |
number | Crédits d'abonnement utilisés sur la période en cours |
subscription.total |
number | Total des crédits d'abonnement alloués par période |
subscription.remaining |
number | Crédits d'abonnement restants sur la période en cours |
subscription.percent_used |
number | Pourcentage de crédits d'abonnement consommés |
credits.given |
number | Crédits bonus accordés au compte |
credits.consumed |
number | Crédits bonus consommés |
credits.remaining |
number | Crédits bonus restants |
credits.percent_used |
number | Pourcentage de crédits bonus consommés |
rate_limit.per_minute |
number | null | Nombre maximum d'appels API par minute (null = illimité) |
rate_limit.per_second |
number | null | Nombre maximum d'appels API par seconde (null = illimité) |
account.name |
string | Nom du compte Piloterr |
account.slug |
string | Identifiant slug du compte |
api_key.alias |
string | Alias lisible de la clé API utilisée |
api_key.active |
boolean | Indique si la clé API est actuellement active |
api_key.category |
string | Catégorie de la clé API (ex. development, production) |
api_key.expires |
string | null | Date d'expiration de la clé API, ou null si elle n'expire pas |
api_key.quotas.total |
number | null | Quota total de requêtes pour la clé (null = illimité) |
api_key.quotas.daily |
number | null | Quota journalier de requêtes (null = illimité) |
api_key.quotas.weekly |
number | null | Quota hebdomadaire de requêtes (null = illimité) |
api_key.quotas.monthly |
number | null | Quota mensuel de requêtes (null = illimité) |
packs |
object | null | Packs API ponctuels, pack par pack (null si le compte n'en a aucun). Pour un compte sans abonnement mensuel, subscription.total est la somme de tous les packs |
packs.count |
number | Nombre de packs actifs |
packs.exhausted_count |
number | Nombre de packs entièrement consommés |
packs.total |
number | Crédits accordés par l'ensemble des packs actifs |
packs.used |
number | Crédits consommés sur l'ensemble des packs |
packs.remaining |
number | Crédits restants sur l'ensemble des packs |
packs.current |
object | null | Le pack en cours de consommation (les packs sont utilisés dans l'ordre d'achat) ; null quand tous sont épuisés |
packs.items[] |
object[] | Chaque pack actif : id, title, purchased_at, total, used, remaining, percent_used, exhausted |
SoldesLink to Soldes
Chaque appel puise dans jusqu'à trois soldes, toujours dans cet ordre. La réponse détaille chacun séparément pour que vous sachiez d'où viennent vos crédits.
- Quota d'abonnement (
subscription) : appels inclus dans un plan mensuel. Remis à zéro à chaque période de facturation (period,renewal_date). - Packs API ponctuels (
packs) : achetés une fois, jamais remis à zéro, consommés dans l'ordre d'achat une fois le quota mensuel épuisé.packs.currentest le pack en cours de consommation ; chaque élément indique ses propresusedetremaining. Sur un compte sans plan mensuel,subscriptionreporte la somme de tous les packs. - Crédits à l'usage (
credits) : utilisés seulement quand quota et packs sont épuisés. Facturés séparément.
remaining est le total encore disponible sur les trois soldes, et total_used le total consommé. Quand remaining atteint 0, les appels renvoient 402 jusqu'à l'ajout d'un pack ou de crédits.
NotesLink to Notes
- Cet endpoint nécessite un en-tête
x-api-keyvalide. Les requêtes sans clé retourneront401 Unauthorized. - Les valeurs
percent_usedpeuvent dépasser 100 en cas de recharge ou de dépassement. - Les valeurs
rate_limitsontnullpour les plans sans limitation de débit.
Cas d'usage principauxLink to Cas d'usage principaux
- Surveiller les crédits restants en temps réel et déclencher des flux de recharge automatisés avant épuisement
- Construire des tableaux de bord internes affichant la consommation API par équipe ou projet
- Mettre en place des systèmes d'alerte notifiant l'équipe lorsque l'utilisation dépasse un seuil défini
- Valider le statut et l'expiration de la clé API avant de lancer des tâches de données en lot
Prêt à commencer ?
Votre API de scraping web est à un clic. Commencez avec +500 crédits, sans infrastructure à gérer, sans proxies à configurer, et sans carte bancaire.
- +500 crédits
- Aucune carte bancaire requise
- Tous les endpoints inclus