Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neynar Onchain API

Operations related to onchain data

This API exposes 19 operations across 18 paths, and defines 36 schemas. It is described by OpenAPI 3.0.4, at version 3.176.0.

Requests are made against a single base URL, https://api.neynar.com.

19 operations 18 paths 36 schemas 10 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
3.176.0
Base URL
https://api.neynar.com
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Neynar Onchain API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key to authorize requests

Paths & Operations 19

Across 18 paths, the API surfaces 19 operations — 10 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Onchain 19

Operations related to onchain data

GET
/v2/farcaster/fungible/owner/relevant/
Relevant owners
fetch-relevant-fungible-owners 3 params → 200400
GET
/v2/farcaster/fungible/owner/relevant/bulk
Bulk relevant owners
fetch-bulk-relevant-fungible-owners 3 params → 200400
POST
/v2/farcaster/fungible/send/
Send fungibles
send-fungibles-to-users 1 param body → 200400500
GET
/v2/farcaster/fungible/trades/
Get fungible trades
fetch-fungible-trades 4 params → 200400500
GET
/v2/farcaster/fungible/trending/
Trending fungibles
fetch-trending-fungibles 2 params → 200400500
GET
/v2/farcaster/fungibles/
Fetch fungibles
fetch-fungibles 3 params → 200400500
POST
/v2/farcaster/nft/deploy/erc721/
Deploy ERC-721 collection
deploy-erc721 1 param body → 201400403404500
POST
/v2/farcaster/nft/image/
Generate an NFT image
generate-image 1 param body → 200400403404500
POST
/v2/farcaster/nft/metadata/token
Upload NFT token metadata
upload-token-metadata 1 param body → 200400403404500
GET
/v2/farcaster/nft/mint/
Simulate NFT mint calldata
simulate-nft-mint 3 params → 200400404500
POST
/v2/farcaster/nft/mint/
Mint NFT(s)
mint-nft 1 param body → 200400401402404500
GET
/v2/farcaster/user/balance/
Token balance
fetch-user-balance 2 params → 200400404500
POST
/v2/farcaster/user/register/
Register Farcaster account onchain
register-account-onchain 1 param body → 200400500
POST
/v2/fungible/
Deploy fungible
deploy-fungible body → 200400500
GET
/v2/onchain/token/balances
Get wallet token balances
get-wallet-balances 4 params → 200400500
GET
/v2/onchain/token/metadata
Get token metadata
get-token-metadata 2 params → 200400404500
GET
/v2/onchain/token/metadata/batch
Batch get token metadata
batch-get-token-metadata 2 params → 200400500
POST
/v2/signature/x402/
Create x402 signature
create-x402-signature 2 params body → 200400401403500
POST
/v2/signature/x402/siwx
Create x402 Sign-In-With-X payload
create-x402-siwx 2 params body → 200400401403500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are User (18 properties), DeployFungibleReqBody (12 properties), Fungible (8 properties), UserDehydrated (7 properties). Each schema is shown below with its type and property counts.

TokenBalance
object
The token balance associated with a wallet address and a network
3 properties 3 required
ChannelUserContext
object
Adds context on the viewer's or author's role in the channel.
2 properties 1 required
BalanceResponse
object
1 property
DeployFungibleResponse
object
1 property
FarcasterFungible
object
3 properties 3 required
SolAddress
string
Solana address
User
object
18 properties 12 required
ChannelMemberRole
string
The role of a channel member
UserViewerContext
object
Adds context on the viewer's follow relationship with the user.
4 properties 4 required
AddressBalance
object
The token balances associated with a wallet address
3 properties 3 required
EthAddress
string
Ethereum address
Location
object
Coordinates and place names for a location
4 properties 2 required
DeployFungibleReqBody
object
12 properties 3 required
FungibleBalance
object
3 properties 3 required
UserDehydrated
object
7 properties 2 required
RegisterUserOnChainResponse
object
3 properties
ChannelDehydrated
object
5 properties 3 required
Network
string
A blockchain network e.g. "ethereum", "optimism", "base", "arbitrum"
LocationAddress
object
5 properties 2 required
RegisterUserOnChainReqBody
object
5 properties 1 required
Ed25519PublicKey
string
Ed25519 public key
ZodError
object
3 properties 3 required
RelevantFungibleOwnersResponse
object
2 properties 2 required
TransactionSendTxInfo
object
4 properties 4 required
PrefixedHexString
string
Hexadecimal number expressed as string with '0x' prefix
TransactionSendFungiblesReceipt
object
4 properties 3 required
Fungible
object
8 properties 8 required
ErrorRes
object
Details for the error response
4 properties 1 required
TextRange
object
2 properties 2 required
FungiblesResponseSchema
object
Response containing fungible details
1 property 1 required
BulkRelevantFungibleOwnersResponse
object
TransactionSendFungiblesRecipient
object
2 properties 2 required
TransactionSendFungiblesReqBody
object
3 properties 2 required
SimulateNftMintResponse
array
Calldata simulations for NFT minting.
TransactionSendFungiblesResponse
object
2 properties 2 required
Fid
integer
The unique identifier of a farcaster user or app (unsigned integer)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neynar-onchain-api-openapi.yml Raw ↑