List pinned objects

List objects pinned to local storage

<p> <span class="hosted">Hosted</span> Endpoint only available for hosted variant. </p>

get/ipfs/pin/list

Request

Base URL
https://ipfs.blockfrost.io/api/v0
URL
https://ipfs.blockfrost.io/api/v0/ipfs/pin/list
Auth
API key in header project_id

Query parameters

countinteger

The number of results displayed on one page.

pageinteger

The page number for listing the results.

order'asc' | 'desc'

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Response

Returns pinned objects

time_createdinteger required

Creation time of the IPFS object on our backends

time_pinnedinteger required

Pin time of the IPFS object on our backends

ipfs_hashstring required

IPFS hash of the pinned object

sizestring required

Size of the object in Bytes

state'queued' | 'pinned' | 'unpinned' | 'failed' | 'gc' required

State of the pinned object, which is queued when we are retriving object. If this is successful the state is changed to pinned or failed if not. The state gc means the pinned item has been garbage collected due to account being over storage quota or after it has been moved to unpinned state by removing the object pin.

filecoinboolean required

Whether filecoin was used to pin the resource.

Example response

[
  {
    "time_created": 1615551024,
    "time_pinned": 1615551024,
    "ipfs_hash": "QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx",
    "size": "1615551024",
    "state": "pinned"
  }
]

Changes

No recorded changes to this operation across all 4 revisions of this API.