Data
listFiles
List and filter files pinned to your Pinata account
Usage
Returns
Parameters
Filter response with the following additional methods. All filters are optional.
name
- Type:
string
Name of the file
cid
- Type:
string
CID of the file
group
- Type:
string
Filter by groupId
keyValue
- Type:
object
Filter files by keyValue
objects used in Pinata Metadata
This also includes an optional operator
for even more fine tuned data
Type:
pageLimit
- Type:
number
Determine the number of results, default is 10
, max is 1000
pageOffset
- Type:
number
Offset the number of files returned to paginate
pinStart
- Type:
string
Filter by start date in ISO8601 format
pinEnd
- Type:
string
Filter by end date in ISO8601 format
pinSizeMin
- Type:
number
Filter by minimum file size in bytes
pinSizeMax
- Type:
number
Filter by maximum file size in bytes
Auto Paginate
The listFiles
method has an auto pagination feature that is triggered when used inside a for await
iterator
Works like magic ✨