> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tronrental.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List API Key Scopes

> The scopes an API key can carry, grouped by kind

## List API Key Scopes

Returns the catalog of API key scopes, grouped the way the dashboard shows them. Use it to discover
the valid scope names.

Node API keys are a separate kind of key: they carry only the `node_api` scope, never together with
the other scopes, and work only at `node.tronrental.com`. You create them as endpoints in
[Dashboard → Node API](https://tronrental.com/dashboard/node-api); how many you can have depends on
your Node API plan. A Node API key cannot call this endpoint — the REST API answers it with
`403 NODE_API_KEY_ONLY`. See [Node API → Endpoints and keys](/node-api/authentication).

### Response

**read** `string[]`

Read scopes: `view`, `deposit_view`

**node** `string[]`

The Node API scope: `node_api`. A key with it carries no other scope

**write** `string[]`

Scopes that spend the balance or change services: `buy_energy`, `buy_bandwidth`, `smart_mode`,
`transfer_packages`, `energy_resale`

**danger** `string[]`

`withdraw`. Enabling it on a key requires 2FA and a non-empty IP whitelist

**default** `string[]`

Scopes a new REST API key gets when none are chosen: every read and write scope, without `withdraw`

**locked** `string[]`

Scopes every REST API key always has: `view`

### Example

```bash theme={null}
curl https://api.tronrental.com/v1/auth/api-keys/scopes \
  -H "X-API-Key: your_api_key"
```

```json Response theme={null}
{
  "read": ["view", "deposit_view"],
  "node": ["node_api"],
  "write": ["buy_energy", "buy_bandwidth", "smart_mode", "transfer_packages", "energy_resale"],
  "danger": ["withdraw"],
  "default": ["view", "deposit_view", "buy_energy", "buy_bandwidth", "smart_mode", "transfer_packages", "energy_resale"],
  "locked": ["view"]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.