GET
/
data
/
pinList
curl --request GET \
  --url https://api.pinata.cloud/data/pinList \
  --header 'Authorization: Bearer <token>'
{
  "rows": [
    {
      "id": "<string>",
      "ipfs_pin_hash": "<string>",
      "size": 123,
      "user_id": "<string>",
      "date_pinned": "<string>",
      "date_unpinned": "<string>",
      "metadata": {
        "name": "<string>",
        "keyvalues": "<any>"
      },
      "regions": [
        {
          "regionId": "<string>",
          "currentReplicationCount": 123,
          "desiredReplicationCount": 123
        }
      ]
    }
  ]
}

For more detailed information on listing and querying your files on IPFS, visit the Listing Files doc.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

includeCount
boolean
cid
string

CID of file you are searching for

pinStart
string

ISO_8601 format date to filter by start date for when file was pinned

pinEnd
string

ISO_8601 format date to filter by end date for when file was pinned

unpinStart
string

ISO_8601 format date to filter by start date for when file was unpinned

unpinEnd
string

ISO_8601 format date to filter by end date for when file was unpinned

pinSizeMin
string

Minimum size in bytes of files to return

pinSizeMax
string

Maximum size in bytes of files to return

status
string

Options are "all", "pinned", or "unpinned"

pageLimit
string

Maximum number of files to return. Default is 10, max is 1000

pageOffset
string

Use to paginate through files, default is 0

metadata
string

See metadata querying section below

Response

200 - application/json
rows
object[]
Pin JSONUpdate File Metadata