📦Storage

Learn how to fetch storage data using Airstack Hubs API.

Get Storage Limits And Usages By FID

You can get the detailed storage limit and current storage usages of various categories (cast storage, follow storage, recation storage, etc.) that a specific FID has by using Airstack Hubs API with the code below:

@farcaster/hub-nodejs

import {
  Metadata,
  getSSLHubRpcClient,
} from "@farcaster/hub-nodejs";
import { config } from "dotenv";

config();

const client = getSSLHubRpcClient("hubs-grpc.airstack.xyz");

client.$.waitForReady(Date.now() + 5000, async (e) => {
  if (e) {
    console.error(`Failed to connect to the gRPC server:`, e);
    process.exit(1);
  } else {
    console.log(`Connected to the gRPC server`);
    const metadata = new Metadata();
    // Provide API key here
    metadata.add("x-airstack-hubs", process.env.AIRSTACK_API_KEY as string);

    // Fetch Hubs info data with `getCurrentStorageLimitsByFid`
    const storageRes = await client.getCurrentStorageLimitsByFid(
      { fid: 6833 },
      metadata
    );
    console.log(storageRes.value);
    // After everything, close the RPC connection
    client.close();
  }
});

axios

import axios from "axios";
import { config } from "dotenv";

config();

const main = async () => {
  const server = "https://hubs.airstack.xyz";
  try {
    const response = await axios.get(`${server}/v1/storageLimitsByFid?fid=6833`, {
      headers: {
        "Content-Type": "application/json",
        // Provide API key here
        "x-airstack-hubs": process.env.AIRSTACK_API_KEY as string,
      },
    });
  
    console.log(response);
  
    console.log(json);
  } catch (e) {
    console.error(e);
  }
}

main();

Response

{
  "limits": [
    {
      "storeType": "STORE_TYPE_CASTS", // Cast Storage
      "name": "\b\u0004�",
      "limit": 75000,
      "used": 25488,
      "earliestTimestamp": 108097112,
      "earliestHash": "K/krBlhQPy2ps3S+16OvvdPOjhM="
    },
    {
      "storeType": "STORE_TYPE_LINKS", // Follow Storage
      "name": ",�J",
      "limit": 37500,
      "used": 3391,
      "earliestTimestamp": 108090342,
      "earliestHash": "W3FsMBBZUMHJZvLeOjsBFgcLrKA="
    },
    {
      "storeType": "STORE_TYPE_REACTIONS", // Reaction Storage
      "name": "D@\u0002L��",
      "limit": 37500,
      "used": 37500,
      "earliestTimestamp": 85728693,
      "earliestHash": "31caeSXVnC1wV2qZMRgw6ttP2Xw="
    },
    {
      "storeType": "STORE_TYPE_USER_DATA", // User Profile Storage
      "name": "Q!\u0011�0\u0013",
      "limit": 750,
      "used": 4,
      "earliestTimestamp": 69403216,
      "earliestHash": "XzbR+DhAEAQAQpanel46whd4mVw="
    },
    {
      "storeType": "STORE_TYPE_USERNAME_PROOFS", // Username Proofs Storage
      "name": "Q!\u00114\u0003\u0004��N8T",
      "limit": 75,
      "used": 2,
      "earliestTimestamp": 80755811,
      "earliestHash": "UiDlOTI7DUyvm77kMWKg8pW3zx0="
    },
    {
      "storeType": "STORE_TYPE_VERIFICATIONS", // Connected/Verifid Accounts Storage
      "name": "TDH\u0014��L��",
      "limit": 375,
      "used": 5,
      "earliestTimestamp": 77306045,
      "earliestHash": "oxQVvW/ln0rgRYjr4UmM7FNHJgU="
    }
  ],
  "units": 15
}

Developer Support

If you have any questions or need help regarding integrating storage data using Airstack Hubs API into your Farcaster app, please join our Airstack's Telegram group.

More Resources

• Casts

• Reactions

• Links

• User Data

• FIDs

• Username Proofs

• Verifications

• Message

• Hub Events

• Onchain Events