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 usage for a given user

farcasterStorage.getStorageUsage

Overview

Fetches storage usage for a given user

Parameters

name
type
required
Note

fid

number

true

ex) 721870

Usage

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

Response

{
  "object": "storage_usage",
  "user": {
    "object": "user_dehydrated",
    "fid": 721870
  },
  "total_active_units": 1,
  "casts": {
    "object": "storage",
    "used": 7,
    "capacity": 5000
  },
  "reactions": {
    "object": "storage",
    "used": 2,
    "capacity": 2500
  },
  "links": {
    "object": "storage",
    "used": 116,
    "capacity": 2500
  },
  "verifications": {
    "used": 0,
    "capacity": 25
  },
  "username_proofs": {
    "used": 0,
    "capacity": 5
  },
  "signers": {
    "used": 1,
    "capacity": 1000
  }
}

Category

Used

Capacity

Total Active Units

1

-

Casts

7

5000

Reactions

2

2500

Links

116

2500

Verifications

0

25

Username Proofs

0

5

Signers

1

1000

Field Description

  • Category: Data category

  • Used: Amount of storage space used

  • Capacity: Total storage space capacity

PreviousFetches storage allocations for a given userNextFarcasterFname

Last updated 9 months ago