Skip to main content
The locations endpoints return the targeting values you put into a proxy username. Rather than hardcoding a country or city name and hoping it resolves, you query the list and use a value the network recognises. All requests go to https://api.nodemaven.com/api/v2/base/ and carry the header Authorization: x-api-key YOUR_API_KEY. See the NodeMaven API overview for the shared basics.

​
Endpoints

​
Query parameters

Every locations endpoint is paginated and requires limit and offset. These four parameters are shared across all of them: On top of those, each level takes its own filters. GET /locations/countries/ also takes: GET /locations/regions/ requires country__code, because regions are always looked up inside a country:
country__code has a double underscore. Written with a single underscore the parameter is not recognised, so the required country code counts as missing.
The cities, ISP and ZIP code endpoints follow the same drill-down pattern: pass the pagination parameters, then the code of the level above the one you are listing. Three things to carry across every call: pagination is required, a country code is required once you go below country level, and the connection type is residential unless you say otherwise.

​
Targeting limits to know about

Two constraints will change which of these endpoints are useful to you:
  • ZIP code targeting is United States only. See ISP and ZIP targeting.
  • ISP proxies are targeted at country level only. City, region and ISP-level targeting applies to Residential and Mobile, not to ISP proxies. See ISP proxy locations.
  • Locations covers location targeting for Residential and Mobile in the dashboard.
  • Proxy string shows where these values go in the username.