Skip to main content

pin_ls

/api/v0/pin/ls​

Lists objects pinned to local storage.

REQUEST​

curl "https://ipfs.infura.io:5001/api/v0/pin/ls?arg=<ipfs-path>&type=all&quiet=<value>&stream=<value>" \
  -X POST \
  -u "<API_KEY>:<API_KEY_SECRET>"

REQUEST PARAMS​

  • arg [Optional] - Path to object(s) to be listed.
  • type [Optional] - The type of pinned keys to list. Can be direct, indirect, recursive, or all. The default is all.
  • quiet [Optional] - Write just hashes of objects.
  • stream [Optional] - Enable streaming of pins as they are discovered.

RESPONSE​

On success, the call to this endpoint returns with 200 and the following body:

BODY​

{
  "PinLsList": {
    "Keys": {
      "<string>": {
        "Type": "string"
      }
    }
  },
  "PinLsObject": {
    "Cid": "string",
    "Type": "string"
  }
}