x402.cids.list

Pinata SDK x402.cids.list returns the private IPFS CIDs currently associated with a given x402 payment instruction on your Pinata account.

List all CIDs associated with a payment instruction

Usage

import { PinataSDK } from "pinata";

const pinata = new PinataSDK({
  pinataJwt: process.env.PINATA_JWT!,
  pinataGateway: "example-gateway.mypinata.cloud",
});

const cids = await pinata.x402.listCids(
  "01234567-89ab-cdef-0123-456789abcdef"
);

Returns

type CidListResponse = {
  data: {
    cids: string[];
    next_page_token?: string;
  };
};

Parameters

paymentInstructionId (required)

• Type: string

The unique identifier of the payment instruction

const cids = await pinata.x402.listCids(
  "01234567-89ab-cdef-0123-456789abcdef"
);

options

Optional parameters for pagination.

limit

• Type: number

Limit the number of results returned

const cids = await pinata.x402.listCids(
  "01234567-89ab-cdef-0123-456789abcdef",
  {
    limit: 10,
  }
);

pageToken

• Type: string

Paginate through results using a page token from a previous response

const cids = await pinata.x402.listCids(
  "01234567-89ab-cdef-0123-456789abcdef",
  {
    pageToken: "MDE5MWIzZWYtM2U0Zi03YTY5LWE3OTQtOTRhZDE5NjQxMTk0",
  }
);