Skip to main content
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

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

​
Authentication

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

Open Profile

Click Profile in the dashboard’s left navigation.
2

Select API key

Your key is in the API key section.
3

Copy it

Copy the token and send it on every request in the header above.
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.

​
What you can do

The API covers 47 operations. These are the areas it spans. The LLM API shares this base URL and the same key. It has its own section: see 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.

​
Interactive reference

The full interactive reference, with every endpoint’s parameters, schemas and response examples, is available at dashboard.nodemaven.com/documentation/v2/.

The Sub-user feature

What sub-users are and how they work in the dashboard, before you automate them.

IP Whitelist setup

How whitelisting works, and why it is Residential and Mobile only.

Available locations

The targeting values the locations endpoints return.

Proxy usage statistics

The same figures the statistics endpoints expose, as the dashboard shows them.