Lum0x SDK
  • Lum0x-sdk
    • Getting started
    • Examples
      • Case 1 : Find my Fan
      • Case 2: Fetch user's Moxie earning
      • Case 3: Raffle events among the filtered casts
      • How to Deploy a Project with Vercel
    • FarcasterUser
      • Search for Usernames
      • Fetch users based on FIDs
      • Fetch power user objects
      • Fetches users based on Eth or Sol addresses
      • Lookup a user by custody-address
      • Retrieve all channels that a given fid follows
      • Get User Information by username
      • Get Recent Users
    • FarcasterCast
      • Retrieve cast for a given hash or Warpcast URL
      • Retrieve casts for a given user
      • Gets information about an array of casts
      • Retrieve the conversation for a given cast
      • Get Recent Casts
    • FarcasterFeed
      • Retrieve casts based on filters
      • Retrieve trending casts
    • FarcasterReaction
      • Fetches reactions for a given user
      • Fetches reactions for a given cast
    • FarcasterFollowers
      • Retrieve followers for a given user
      • Retrieve relevant followers for a given user
      • Retrieve a list of users followed by a user
    • FarcasterStorage
      • Fetches storage allocations for a given user
      • Fetches storage usage for a given user
    • FarcasterFname
      • Check if a given fname is available
    • FarcasterMute
      • Get fids that a user has muted
    • FarcasterChannel
      • Retrieve all channels with their details
      • Search for channels based on id or name
      • (Bulk) Retrieve channels by id or parent_url
      • Retrieve channel details by id or parent_url
      • Retrieve followers for a given channel
      • Get channels that a user is active in
      • Check If User Follows Channel
      • Retrieve trending channels based on activity
    • FarcasterNotification
      • Retrieve notifications for a given user
    • FarcasterMoxie
      • Retrieve Moxie earning status
      • Retrieve FarScore and FarRank
      • Retrieve Moxie airdrop claim status
      • Retrieve Moxie earning details for cast.
      • Retrieve Moxie earning details for reply.
      • Retrieve Moxie earning details for cast by fid.
      • Retrieve Moxie earning details for reply by fid.
      • Retrieve Moxie earning details from channel cast.
Powered by GitBook
On this page
  • Overview
  • Parameters
  • Usage
  • Response
  • Field Description
  1. Lum0x-sdk
  2. FarcasterStorage

Fetches storage allocations for a given user

farcasterStorage.getStorageAllocations

Overview

Fetches storage allocations for a given user

Parameters

name
type
required
Note

fid

number

true

ex) 721870

Usage

let res = await Lum0x.farcasterStorage.getStorageAllocations({
    fid: 721870
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "total_active_units": 1,
  "allocations": [
    {
      "object": "storage_allocation",
      "user": {
        "object": "user_dehydrated",
        "fid": 721870
      },
      "units": 1,
      "expiry": "2025-06-25T08:17:23.000Z",
      "timestamp": "2024-06-25T08:17:23.000Z"
    }
  ]
}

FID

Units

Expiry Date

Timestamp

721870

1

2025-06-25T08:17:23.000Z

2024-06-25T08:17:23.000Z

Field Description

  • FID: User identifier

  • Units: Number of allocated storage units

  • Expiry Date: Expiration date of the storage space

  • Timestamp: Date and time when the storage space was allocated

PreviousFarcasterStorageNextFetches storage usage for a given user

Last updated 9 months ago