GET
/
v1
/
fids
curl --request GET \
  --url https://hub-api.neynar.com/v1/fids \
  --header 'x-api-key: <api-key>'
{
  "fids": [
    1
  ],
  "nextPageToken": "AuzO1V0DtaItCwwa10X6YsfStlynsGWT"
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

​
shard_id
integer
required

The shard ID to filter by

​
pageSize
integer

Maximum number of messages to return in a single response

​
reverse
boolean

Reverse the sort order, returning latest messages first

​
pageToken
string

The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page

Response

200
application/json
A successful response.
​
fids
integer[]
required

Farcaster ID (FID). A unique identifier assigned to each user in the Farcaster network. This number is permanent and cannot be changed. FIDs are assigned sequentially when users register on the network.

​
nextPageToken
string
required

Base64-encoded pagination token for fetching the next page of results. An empty value indicates there are no more pages to return. Used in conjunction with the pageSize parameter to implement pagination across large result sets.

Example:

"AuzO1V0DtaItCwwa10X6YsfStlynsGWT"