---
title: "Get API account information: credits used, credits remaining etc"
method: GET
path: "/account/credits"
---

# Get API account information: credits used, credits remaining etc

`GET /account/credits`

## Request

- Base URL: `https://api.propertydata.co.uk`
- URL: `https://api.propertydata.co.uk/account/credits`
- Auth: HTTP bearer

Free: costs 0 credits.

## Response `200`

Successful response

- object
  - `status` string
  - `params` object
    - `key` string
  - `result` object
    - `credits_used` integer
    - `credits_remaining` integer
    - `credits_limit` integer
    - `credits_renew_at` string
    - `key_credits_used` integer
  - `process_time` string: Server processing time in seconds

## Other responses

- `4XX`: Error response. Common codes: X02 missing key (400), X03 invalid key (422), X04 credit limit exceeded (403), X06/X07 missing or invalid location input (400/422), X08 insufficient data for location (404), X13 free trial limit exceeded (403), X14 rate limited (429), X20 server busy, retry after 60 seconds (503).

---

[API](https://skmtc.dev/propertydata/apis/propertydata-api.md) · [All operations](https://skmtc.dev/propertydata/apis/propertydata-api/llms.txt) · [OpenAPI document](https://skmtc.dev/propertydata/apis/propertydata-api/revisions/38ab011f2f4c?raw)