Account

Balance and API keys. Returns the credit balance and a summary of the account API keys. Never returns a full key.

GET https://YOUR_API_HOST/v1/account

Credits

Free. This endpoint never spends credits.

Example request

Terminal

curl https://YOUR_API_HOST/v1/account \
  -H "Authorization: Bearer $LOOKVALID_API_KEY"

1const response = await fetch("https://YOUR_API_HOST/v1/account", {
2  headers: { Authorization: `Bearer ${process.env.LOOKVALID_API_KEY}` },
3});
4console.log(await response.json());

1import os
2import requests
3
4response = requests.get(
5    "https://YOUR_API_HOST/v1/account",
6    headers={"Authorization": f"Bearer {os.environ['LOOKVALID_API_KEY']}"},
7    timeout=30,
8)
9print(response.json())

Response

Field	Type	Notes
`account`	object	-
`account.id`	string	-
`account.name`	string	-
`account.created_at`	string	Format: date-time.
`balance`	object	-
`balance.granted`	integer	-
`balance.spent`	integer	-
`balance.reserved`	integer	Credits held by lookups still in flight.
`balance.available`	integer	Credits you can spend now.
`keys`	array of object	-
`keys[].id`	string	Public key id. The key itself is never returned.
`keys[].prefix`	string	-
`keys[].name`	string	-
`keys[].created_at`	string	Format: date-time.
`keys[].revoked`	boolean	-
`keys[].revoked_at`	string or null	Format: date-time.

Response shape

Each value is a stand-in that shows the field type.

1{
2  "account": {
3    "id": "string",
4    "name": "string",
5    "created_at": "string"
6  },
7  "balance": {
8    "granted": 0,
9    "spent": 0,
10    "reserved": 0,
11    "available": 0
12  },
13  "keys": [
14    {
15      "id": "string",
16      "prefix": "string",
17      "name": "string",
18      "created_at": "string",
19      "revoked": false,
20      "revoked_at": "string"
21    }
22  ]
23}

Errors

401 unauthorized: The API key is missing, malformed, revoked or unknown.
429 rate_limited: Too many requests for this API key.