---
title: "API Credits Balance"
method: GET
path: "/usage/credits"
tags: ["API Credits Balance"]
---

# API Credits Balance

`GET /usage/credits`

## Request

- Base URL: `https://public-api.apptweak.com/api/public/apptweak`
- URL: `https://public-api.apptweak.com/api/public/apptweak/usage/credits`
- Auth: API key in header `x-apptweak-key`

Get an overview of your remaining credits, the amount of recurrent credits and additional credits. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Comment</th><th>Credits/request</th></tr></thead> <tbody> <tr><td><b>API Credits balance</b></td><td>Hash containing your credit balance, the cycle renewal time and your plan limits.</td><td>0</td></tr> </tbody> </table> <br/><br/> <b>Good to know</b> <br/><br/> &bull; Bear in mind that we show the credits <b>used</b> on our tool, while on our API it is the credits <b>remaining</b>.

## Response `200`

Successful response.

- object
  - `result` object
    - `current_monthly_api_credits` integer
    - `aso_monthly_api_credits` integer
    - `api_monthly_api_credits` integer
    - `total_monthly_api_credits` integer
    - `next_renewal_date` string
    - `additional_api_credits` integer
  - `metadata` ResponseMetadata: Standard response envelope: the request as the API parsed it, the credits actually charged (`cost`), and what the call could have cost had every datapoint been available (`max_credit_cost`). Every endpoint of this API returns it unchanged.
    - `request` object
      - `path` string: The path that was called.
      - `params` object, nullable: The query as the API parsed it, with defaults applied.
      - `cost` integer: Credits actually charged for this call.
      - `max_credit_cost` integer: Credits the call could have cost if every datapoint requested had been available.
      - `status` integer: HTTP status of the response.
    - `response` object, nullable: Endpoint-specific notes; null when there are none.

## Other responses

- `401`: Unauthorized. Unknown or missing API token.
- `403`: Forbidden. Returned when API access is blocked for the requesting account. This endpoint is free, so it is never returned for insufficient credits.
- `422`: Validation error. Returned when a request parameter is invalid; this endpoint takes no parameters, so it is not expected in normal use.

---

[API](https://skmtc.dev/apptweak/apis/apptweak-api.md) - [All operations](https://skmtc.dev/apptweak/apis/apptweak-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apptweak/apis/apptweak-api/revisions/76dfd41ade5d?raw)