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

# NodeMaven API

> Authenticate with your API key and manage proxies, locations, sub-users, statistics, webhooks and whitelisted IPs programmatically.

The NodeMaven API lets you do programmatically what you would otherwise do in the dashboard: read your account and balance, look up targeting locations, manage sub-users and whitelisted IPs, pull usage statistics, and configure webhooks.

## Base URL

```text theme={null}
https://api.nodemaven.com/api/v2/base/
```

Every endpoint on this page sits under that prefix. A full request URL looks like:

```text theme={null}
https://api.nodemaven.com/api/v2/base/account/balance/
```

## Authentication

Every request takes your API key in the `Authorization` header. **Note the prefix is `x-api-key`, not `Bearer`.**

```text theme={null}
Authorization: x-api-key YOUR_API_KEY
```

```bash theme={null}
curl https://api.nodemaven.com/api/v2/base/account/balance/ \
  -H "Authorization: x-api-key YOUR_API_KEY"
```

<Steps>
  <Step title="Open Profile">
    Click **Profile** in the dashboard's left navigation.
  </Step>

  <Step title="Select API key">
    Your key is in the **API key** section.
  </Step>

  <Step title="Copy it">
    Copy the token and send it on every request in the header above.
  </Step>
</Steps>

<Warning>
  **Treat your API key like a password.** It authorises actions on your account, including creating and deleting sub-users and changing your IP whitelist. Keep it server-side, out of client-side code and out of version control.
</Warning>

## What you can do

The API covers **47 operations**. These are the areas it spans.

| Area | What it covers |
| - | - |
| **Account** | Your account details and current traffic balance |
| **API keys** | List, create, inspect and revoke your API keys |
| **Locations** | Countries, regions, cities, ISPs and ZIP codes available for targeting |
| **Statistics** | Traffic used, requests made, and the breakdown by domain |
| **Sub-users** | Create, update, list and delete sub-users, and reset their usage |
| **IP whitelist** | Add, list and remove whitelisted IP addresses |
| **Webhooks** | Create and manage webhooks, list event types, rotate secrets |
| **Proxy** | Proxy capabilities, and location checks on a proxy configuration |
| **Notifications** | Read and dismiss account notifications |

The **LLM API** shares this base URL and the same key. It has its own section: see [LLM API reference](/llm-api/reference).

The **Scraping Browser** is a separate API with its own host and a Bearer token rather than this key. See [Scraping Browser API reference](/scraping-browser/api-reference).

## Interactive reference

The full interactive reference, with every endpoint's parameters, schemas and response examples, is available at [dashboard.nodemaven.com/documentation/v2/](https://dashboard.nodemaven.com/documentation/v2/swagger/).

## Related

<CardGroup cols={2}>
  <Card title="The Sub-user feature" icon="users" href="/residential-mobile/sub-users">
    What sub-users are and how they work in the dashboard, before you automate them.
  </Card>

  <Card title="IP Whitelist setup" icon="shield-check" href="/residential-mobile/ip-whitelist">
    How whitelisting works, and why it is Residential and Mobile only.
  </Card>

  <Card title="Available locations" icon="location-dot" href="/residential-mobile/locations">
    The targeting values the locations endpoints return.
  </Card>

  <Card title="Proxy usage statistics" icon="chart-column" href="/residential-mobile/usage-statistics">
    The same figures the statistics endpoints expose, as the dashboard shows them.
  </Card>
</CardGroup>


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