Skip to content

Users

Manage your Forager account. Retrieve the current authenticated user, create and revoke API keys used to authenticate requests to the rest of the API, and review the credit balance-change log that records every lookup charge or adjustment against your account.

Credit Balance Change Log

Request

The Credit Balance Change Log endpoint provides a list of all credit balance change logs related to the current subscription. It returns a list of credit balance change logs, including the change type, change sum, and change data. This endpoint is useful for tracking and analyzing credit consumption patterns, monitoring usage, and ensuring proper subscription management.

Security
Api-Key
Path
account_idintegerrequired
Query
date_created_endstring, (date-time)
date_created_startstring, (date-time)
pageinteger

A page number within the paginated result set.

curl -i -X GET \
  'https://api-v2.forager.ai/api/{account_id}/subscriptions/balance_change_logs/?date_created_end=2019-08-24T14%3A15%3A22Z&date_created_start=2019-08-24T14%3A15%3A22Z&page=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countinteger
Example:15
nextinteger or null
Example:2
previousinteger or null
Example:null
resultsArray of objects(CreditsBalanceChangeLog)
Response
{ "count": 15, "next": 2, "previous": null, "results": [ { … } ] }