Skip to main content
GET
/
v2
/
farcaster
/
storage
/
allocations
Allocation of user
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/storage/allocations/ \
  --header 'x-api-key: <api-key>'
{
  "total_active_units": 13,
  "allocations": [
    {
      "object": "storage_allocation",
      "user": {
        "object": "user_dehydrated",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "pfp_url": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "score": 123
      },
      "units": 10,
      "expiry": "2024-10-08T22:03:49.000Z",
      "timestamp": "2023-10-09T22:03:49.000Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Node.js SDK

🔗 SDK Method: lookupUserStorageAllocations Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

Authorizations

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

API key to authorize requests

Query Parameters

​
fid
integer<int32>
required

The unique identifier of a farcaster user or app (unsigned integer)

Required range: x >= 0
Example:

3

Response

Success

​
total_active_units
integer
Example:

13

​
allocations
StorageAllocation · object[]