curl --request POST \
--url https://api.neynar.com/v2/farcaster/user/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"signature": "<string>",
"fid": 123,
"requested_user_custody_address": "<string>",
"deadline": 123,
"signer": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signed_key_request_metadata_signature": "<string>",
"app_fid": 123,
"deadline": 123
},
"fname": "<string>",
"metadata": {
"bio": "<string>",
"pfp_url": "<string>",
"url": "<string>",
"username": "<string>",
"display_name": "<string>",
"verified_accounts": {
"x": "<string>",
"github": "<string>"
},
"location": {
"latitude": 0,
"longitude": 0
}
}
}
'{
"success": true,
"message": "<string>",
"signers": [
{
"public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
"status": "generated",
"uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"object": "signer",
"signer_approval_url": "<string>",
"fid": 3,
"permissions": [
"WRITE_ALL"
]
}
],
"signer": {
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
"status": "generated",
"object": "signer",
"signer_approval_url": "<string>",
"fid": 3,
"permissions": [
"WRITE_ALL"
]
},
"user": {
"object": "user",
"fid": 3,
"username": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"profile": {
"bio": {
"text": "<string>",
"mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"score": 123
}
],
"mentioned_profiles_ranges": [
{
"start": 1,
"end": 1
}
],
"mentioned_channels": [
{
"id": "<string>",
"name": "<string>",
"object": "channel_dehydrated",
"image_url": "<string>",
"viewer_context": {
"following": true,
"role": "member"
}
}
],
"mentioned_channels_ranges": [
{
"start": 1,
"end": 1
}
]
},
"location": {
"latitude": 0,
"longitude": 0,
"address": {
"city": "<string>",
"country": "<string>",
"state": "<string>",
"state_code": "<string>",
"country_code": "<string>"
},
"radius": 1
},
"banner": {
"url": "<string>"
}
},
"follower_count": 123,
"following_count": 123,
"verifications": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"auth_addresses": [
{
"address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"app": {
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"score": 123
}
}
],
"verified_addresses": {
"eth_addresses": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"sol_addresses": [
"<string>"
],
"primary": {
"eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"sol_address": "<string>"
}
},
"verified_accounts": [
{
"platform": "x",
"username": "<string>"
}
],
"display_name": "<string>",
"pro": {
"status": "subscribed",
"subscribed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"pfp_url": "<string>",
"experimental": {
"neynar_user_score": 123,
"deprecation_notice": "<string>"
},
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
},
"score": 123
}
}Register account on farcaster.
Note: This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user.
curl --request POST \
--url https://api.neynar.com/v2/farcaster/user/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"signature": "<string>",
"fid": 123,
"requested_user_custody_address": "<string>",
"deadline": 123,
"signer": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signed_key_request_metadata_signature": "<string>",
"app_fid": 123,
"deadline": 123
},
"fname": "<string>",
"metadata": {
"bio": "<string>",
"pfp_url": "<string>",
"url": "<string>",
"username": "<string>",
"display_name": "<string>",
"verified_accounts": {
"x": "<string>",
"github": "<string>"
},
"location": {
"latitude": 0,
"longitude": 0
}
}
}
'{
"success": true,
"message": "<string>",
"signers": [
{
"public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
"status": "generated",
"uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"object": "signer",
"signer_approval_url": "<string>",
"fid": 3,
"permissions": [
"WRITE_ALL"
]
}
],
"signer": {
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
"status": "generated",
"object": "signer",
"signer_approval_url": "<string>",
"fid": 3,
"permissions": [
"WRITE_ALL"
]
},
"user": {
"object": "user",
"fid": 3,
"username": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"profile": {
"bio": {
"text": "<string>",
"mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"score": 123
}
],
"mentioned_profiles_ranges": [
{
"start": 1,
"end": 1
}
],
"mentioned_channels": [
{
"id": "<string>",
"name": "<string>",
"object": "channel_dehydrated",
"image_url": "<string>",
"viewer_context": {
"following": true,
"role": "member"
}
}
],
"mentioned_channels_ranges": [
{
"start": 1,
"end": 1
}
]
},
"location": {
"latitude": 0,
"longitude": 0,
"address": {
"city": "<string>",
"country": "<string>",
"state": "<string>",
"state_code": "<string>",
"country_code": "<string>"
},
"radius": 1
},
"banner": {
"url": "<string>"
}
},
"follower_count": 123,
"following_count": 123,
"verifications": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"auth_addresses": [
{
"address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"app": {
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"score": 123
}
}
],
"verified_addresses": {
"eth_addresses": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"sol_addresses": [
"<string>"
],
"primary": {
"eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"sol_address": "<string>"
}
},
"verified_accounts": [
{
"platform": "x",
"username": "<string>"
}
],
"display_name": "<string>",
"pro": {
"status": "subscribed",
"subscribed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"pfp_url": "<string>",
"experimental": {
"neynar_user_score": 123,
"deprecation_notice": "<string>"
},
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
},
"score": 123
}
}developer_managed signers, use this version of the API. If confused, you’re likely not using developer managed signers.API key to authorize requests
Show child attributes
Success
true, false Show child attributes
Ed25519 public key
"0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22"
generated, pending_approval, approved, revoked UUID of the signer.
signer_uuid is paired with API key, can't use a uuid made with a different API key.
"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"
signer The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
WRITE_ALL, READ_ONLY, NONE, PUBLISH_CAST, DELETE_CAST, PUBLISH_REACTION, DELETE_REACTION, UPDATE_PROFILE, FOLLOW_USER, UNFOLLOW_USER, FOLLOW_CHANNEL, UNFOLLOW_CHANNEL, ADD_VERIFICATION, REMOVE_VERIFICATION, WRITE_FRAME_ACTION Show child attributes
UUID of the signer.
signer_uuid is paired with API key, can't use a uuid made with a different API key.
"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"
Ed25519 public key
"0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22"
generated, pending_approval, approved, revoked signer The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
WRITE_ALL, READ_ONLY, NONE, PUBLISH_CAST, DELETE_CAST, PUBLISH_REACTION, DELETE_REACTION, UPDATE_PROFILE, FOLLOW_USER, UNFOLLOW_USER, FOLLOW_CHANNEL, UNFOLLOW_CHANNEL, ADD_VERIFICATION, REMOVE_VERIFICATION, WRITE_FRAME_ACTION Show child attributes
user The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Show child attributes
Show child attributes
Show child attributes
user_dehydrated The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_profiles list.
Show child attributes
channel_dehydrated Adds context on the viewer's or author's role in the channel.
Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_channels list.
Coordinates and place names for a location
Show child attributes
-90 <= x <= 90-180 <= x <= 180The radius in meters for the location search. Any location within this radius will be returned.
x >= 0The number of followers the user has.
The number of users the user is following.
Ethereum address
Show child attributes
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Show child attributes
user_dehydrated The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Show child attributes
List of verified Ethereum addresses of the user sorted by oldest to most recent.
Ethereum address
List of verified Solana addresses of the user sorted by oldest to most recent.
Solana address
The URL of the user's profile picture
Adds context on the viewer's follow relationship with the user.
Show child attributes
Indicates if the viewer is following the user.
Indicates if the viewer is followed by the user.
Indicates if the viewer is blocking the user.
Indicates if the viewer is blocked by the user.
Score that represents the probability that the account is not spam.
Was this page helpful?