Neynar Documentation
By ID or parent_url
Group: Channel APIs
Use this when you need: By ID or parent_url.
Usage
import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";
const client = new NeynarAPIClient(
new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
);
const res = await client.lookupChannel({
id: "example", // Channel ID for the channel being queried
// type: "value",
// viewerFid: 123,
});
console.log(res);
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
✅ | Channel ID for the channel being queried |
type |
LookupChannelTypeEnum |
❌ | - |
viewerFid |
number |
❌ | - |
Response
Returns a RequestArgs object.
Error Handling
try {
const res = await client.lookupChannel({
id: "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.