Skip to main content

v1/pinning REST API Endpoint

Returns all pinned objects

Updated on
Oct 19, 2023

v1/pinning REST API Endpoint

Query Parameters

pageNumber
number
The page number of results that were returned with this response
perPage
number
The maximum amount of objects to return on each page

Returns

data
array
A list of data containing information about each pinned object
id
integer
Represents the ID of the pinned object
uuid
string
Represents the Universally Unique Identifier (UUID) of the pinned object
createdAt
string
Specifies the date and time when the pinned object was created
updatedAt
string
Indicates the date and time when the pinned object was last updated
requestId
string
Represents the ID of the request associated with the pinned object
cid
string
Represents the Content Identifier (CID) associated with the pinned object
name
string
Specifies the name associated with the pinned object
contentType
string
Represents the content type of the pinned object
size
string
Represents the size of the pinned object
origins
array
Represents the origins of the pinned object
status
string
Describes the status of the pinned object
meta
object
Contains details about the metadata of the pinned object
source
string
The source of the object
parentId
string
The parent id
type
string
The type of the object
path
string
The path of the object
totalItems
integer
Represents the total number of items in the response
totalPages
integer
Represents the total number of pages in the response
pageNumber
integer
The page number of results that were returned with this response
Request
1
curl --location 'https://api.quicknode.com/ipfs/rest/v1/pinning?pageNumber=1&perPage=10' \
2
--header 'x-api-key: YOUR_API_KEY'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free