API Keys

Blog

Community

Pinata Docs

SDKs

API Reference

Farcaster

Pinata App

Provide Feedback

Support

List API Keys

bearerAuth

Start uploading and retrieving content to IPFS in no time

Quickstart

About Pinata

Next.js

React

Node.js

Workspaces

Login with Farcaster and connect your Pinata account

Farcaster Integration

Billing

Limits

What is IPFS?

What is Pinning?

What are CIDs?

What are IPFS Gateways?

How does IPFS work with NFTs?

Pinning Files

Groups

Listing Files

Pinata Metadata & Options

Deleting Files

Dedicated IPFS Gateways

Gateway Access Controls

Image Optimizations

Introduction

Test your API keys and your ability to connect to the Pinata API

Test Authentication

Upload a file to Pinata to be pinned to IPFS

Pin File to IPFS

Uploads a JSON object to Pinata and pins it to IPFS

Pin JSON

List all the files on your Pinata account

List Files

Update File Metadata

Delete File (Unpin)

Create Group

Get a Group

List Groups

Update Group

Add CIDs to Group

Remove CIDs from a Group

Delete Group

Upload a file already on the IPFS network to Pinata

Pin By CID

List all currently running pinByHash jobs

List Pin By CID Jobs

Pinning Service API

List Gateways

Gateway Details

Gateway Domain Available

Create Gateway

Delete Gateway

Gateway Custom Domain Details

Create Custom Domain for Gateway

Delete Gateway Custom Domain

Create Gateway Key Restriction

Create Gateway IP Address Restriction

Create Gateway Host Origin Restriction

Revoke Gateway Key

Revoke IP Address Restricton

Revoke Host Origin Restriction

Generate Pinata API Key

Revoke API Key

Create API Key

Pinata SDK

Next.js Starter

Pinata CLI

Pinata Raycast Extension

Community SDKs

Getting Started

Config

testAuthenticaiton

listFiles

pinJobs

unpin

updateMetadata

file

fileArray

json

base64

convert

create

addCids

removeCids

list

update

delete

revoke

pinnedFileCount

totalStorageSize

Types

The easiest way to manage signers for your Farcaster applications

Farcaster Auth

Farcaster API

Leverage Pinata + IPFS to add decentralized image uploads to your Farcaster client

Image Uploads

Learn more about Farcaster Frames and how to build them!

Frames

Hubs

A directory of dev call notes from the Pinata team

Farcaster Dev Calls

Learn how to the get up and running with the Farcaster Development Kit

Use the FDK to make writes to the Farcaster Network

Farcaster Writes

Use the FDK to make reads from the Farcaster Network

Farcaster Reads

Farcaster Frames

Cast by Hash

Casts

Send Cast

Delete Cast

Add Reaction to Cast

Delete Reaction to Cast

Channels List

Channel By Name

Follow FID

Unfollow FID

User By FID

Users

Learn the basics of creating signers for your Farcaster App

Signers

Register Signer with Warpcast

Poll Warpcast Signer

Get Signers

Send Analytics

Get Interactions

Get Top Interactions

Info

Fetch all casts authored by an FID.

Fetch all casts by parent cast's FID and Hash OR by the parent's URL

Fetch all casts that mention an FID

Get a cast by its FID and Hash.

Get a reaction by its created FID and target Cast.

Get all reactions by an FID

Get all reactions to a cast

Get all reactions to a target URL

Get a link by its FID and target FID.

Get all links to a target FID

Get all links from a source FID

**Note:** one of two different response schemas is returned  based on whether the caller provides the `user_data_type` parameter. If included, a single `UserDataAdd` message is returned (or a `not_found` error). If omitted, a paginated list of `UserDataAdd` messages is returned instead

Get UserData for a FID.

Get a list of proofs provided by an FID

Get an proof for a username by the Farcaster username

Get a list of verifications provided by an FID

Get a list of all the FIDs

Get an FID's storage limits.

Get a list of on-chain events provided by an FID

**Note:** one of two different response schemas is returned  based on whether the caller provides the `signer` parameter. If included, a single `OnChainEventSigner` message is returned (or a `not_found` error). If omitted, a  non-paginated list of `OnChainEventSigner` messages is returned instead

Get a list of signers provided by an FID

Get an on chain ID Registry Event for a given Address

API Documentation

Authentication

Pinning

Groups

Pinning by CID

Gateways

Users

List API Keys

Authorizations

Response