Neynar Documentation
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
By location
Group: User APIs
Use this when you need: By location.
Usage
import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";
const client = new NeynarAPIClient(
new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
);
const res = await client.fetchUsersByLocation({
latitude: 123, // Latitude of the location
longitude: 123, // Longitude of the location
// xNeynarExperimental: true,
// viewerFid: 123,
// limit: 123,
// cursor: "example",
});
console.log(res);
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
latitude |
number |
✅ | Latitude of the location |
longitude |
number |
✅ | Longitude of the location |
xNeynarExperimental |
boolean |
❌ | - |
viewerFid |
number |
❌ | - |
limit |
number |
❌ | - |
cursor |
string |
❌ | - |
Response
Returns a RequestArgs object.
Error Handling
try {
const res = await client.fetchUsersByLocation({
latitude: 123,
longitude: 123
});
// use res
} catch (err) {
// Axios/HTTP errors, invalid params, auth issues, etc.
console.error(err);
}
Tips
- Provide a viewerFid when supported to respect mutes/blocks and include
viewer_context. - Keep requests scoped (e.g., use
limit) to improve latency. - Cache results where sensible.
📖 API Reference: fetchUsersByLocation For detailed information about the HTTP endpoint, request/response schemas, and additional examples, see the complete API documentation.