Neynar Documentation
By custody-address
Group: User APIs
Use this when you need: By custody-address.
Usage
import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";
const client = new NeynarAPIClient(
new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
);
const res = await client.lookupUserByCustodyAddress({
custodyAddress: "example", // Custody Address associated with mnemonic
});
console.log(res);
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
custodyAddress |
string |
✅ | Custody Address associated with mnemonic |
Response
Returns a RequestArgs object.
Error Handling
try {
const res = await client.lookupUserByCustodyAddress({
custodyAddress: "example"
});
// 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.