urlscan.io logo urlscan.io
SecurityTrails logo

docs.pinata.cloud Open in urlscan Pro
2606:4700:4400::ac40:9ae1  Public Scan

Back to summary
Submitted URL: https://url.de.m.mimecastprotect.com/s/9f-GCx6pRncBm2g2fp7DUi?domain=mail.pinata.cloud
Effective URL: https://docs.pinata.cloud/farcaster/farcaster-api/getting-started?utm_medium=email&_hsenc=p2ANqtz-_eh4Uva21JNq2CYodWOVdi3J...
Submission: On April 03 via api from US — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

Pinata Docs home page
Search or ask...Ctrl K
 * Pinata App
 * Support
 * Pinata App


Switch theme
Search
Navigation
Getting Started
DocumentationSDKsAPI ReferenceFarcaster
 * 
   API Keys
 * 
   Blog
 * 
   Community

   GET STARTED
   
   Introduction
   Farcaster Auth
   Farcaster API
   Frames
   Hubs

   DEV TOOLS
   
   Farcaster Development Kit

   FARCASTER API
   
   Getting Started
   GET
   Cast by Hash
   GET
   Casts
   POST
   Send Cast
   DEL
   Delete Cast
   POST
   Add Reaction to Cast
   DEL
   Delete Reaction to Cast
   GET
   Channels List
   GET
   Channel By Name
   POST
   Follow FID
   DEL
   Unfollow FID
   GET
   User By FID
   GET
   Users

   FARCASTER AUTH
   
   Getting Started
   POST
   Signers
   POST
   Sponsored Signers
   POST
   Register Signer with Warpcast
   POST
   Poll Warpcast Signer
   GET
   Get Signers

   FRAME ANALYTICS API
   
   Getting Started
   POST
   Send Analytics
   GET
   Get Interactions
   GET
   Get Top Interactions

   HUB API REFERENCE
   
   Info
   
   Casts
   
   Reactions
   
   Links
   
   User Data
   
   Username Proofs
   
   Verifications
   
   FIDs
   
   Storage
   
   Onchain API


GETTING STARTED



Welcome to the Pinata Farcaster API! The Farcaster API is a free to use API that
references the Pinata Hub replicator database, so instead of using the Hub API
you can get much easier to use data at much faster speeds.

To get started you will need a Pinata API Key!


API KEYS

Visit the Pinata API Keys page to generate new keys.

In the ‘New Key’ modal, you can choose if you want the key to be an Admin key
and have full access over every endpoint, or scope the keys by selecting which
endpoints you want to use. You can also give it a limited number of uses, so be
sure to give it a name to keep track of it. Once you have that filled out, click
“Generate API Key” and it will show you the pinata_api_key,
pinata_api_secret_key, and the JWT. It’s best to click “Copy All” and keep the
API key data safe and secure.

Once API keys have been created, you will not be able to see the secret or JWT
again

Once you have created your keys you can go ahead and try testing them! Try to
paste this into your terminal with your JWT

Copy

curl --request GET \
     --url https://api.pinata.cloud/v3/farcaster/users/1 \
     --header 'accept: application/json' \
     --header 'authorization: Bearer YOUR_PINATA_JWT'


If successful you should see something like this!

200
Copy

{
  "data": {
    "fid": 1,
    "custody_address": "0x8773442740c17c9d0f0b87022c722f9a136206ed",
    "recovery_address": "0x00000000fcb080a4d6c39a9354da9eb9bc104cd7",
    "following_count": 2,
    "follower_count": 7945,
    "verifications": ["0x86924c37a93734e8611eb081238928a9d18a63c0"],
    "bio": "A sufficiently decentralized social network. farcaster.xyz",
    "display_name": "Farcaster",
    "pfp_url": "https://i.imgur.com/I2rEbPF.png",
    "username": "farcaster"
  }
}



ENDPOINTS OVERVIEW


/CASTS

This endpoint is great for fetching a particular cast or by combining with query
parameters to get specific lists of casts.


CASTS BY FID

/casts?fid=6023


Returns all the casts from user FID 6023


CASTS BY FOLLOWING

/casts?fid=6023&following=true


Returns all the casts from users that FID 6023 is following


CASTS BY CHANNEL

/casts?channel=https://warpcast.com/~/channel/pinata


Returns all the casts from a specific channel, e.g.
https://warpcast.com/~/channel/pinata


/CHANNELS

The /channels endpoint can be used to fetch info about a specific channel or
fetch a list of channels


/USERS

This endpoint is similar to /casts in that you can either fetch a specific user
by FID or you can combine multiple query parameters to get specific lists of
users.


USERS FOLLOWING FID

/users?fid=6023&followers=true


Returns all the users following a specific FID


USERS FID FOLLOWING

/users?fid=6023&following=true


Returns all the users a specific FID is following

Suggest edits
websitetwittergithublinkedin
Powered by Mintlify
 * API Keys
 * Endpoints Overview
 * /casts
 * Casts by FID
 * Casts by Following
 * Casts by Channel
 * /channels
 * /users
 * Users Following FID
 * Users FID Following