get https://api.similarweb.com/v3/batch/user-credits
This endpoint provides the ability to get your current remaining user credits
Response
The response contains a DataCredits response, describing the current amount of remaining data credits for the user.
DataCredits Object
This object describes the current user credits state.
Property | Description | Example |
---|---|---|
user_allowance int | The monthly user credit allowance. | 100 |
user_remaining int | The current user credits amount. | 50 |
Note:
This endpoint is relevant only if the requesting user has a set credits limitation. if a limitation is not set, both values will return as null.
If a limit is not set you can refer to this endpoint: Get Remaining Credits