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,
"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>",
"signer": {
"object": "signer",
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
"status": "generated",
"signer_approval_url": "<string>",
"fid": 3,
"permissions": [
"WRITE_ALL"
]
},
"user": {
"object": "user",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"pro": {
"status": "subscribed",
"subscribed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"pfp_url": "<string>",
"profile": {
"bio": {
"text": "<string>",
"mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
}
],
"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>",
"state": "<string>",
"state_code": "<string>",
"country": "<string>",
"country_code": "<string>"
},
"radius": 1
},
"banner": {
"url": "<string>"
}
},
"follower_count": 123,
"following_count": 123,
"verifications": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"verified_addresses": {
"eth_addresses": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"sol_addresses": [
"<string>"
],
"primary": {
"eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"sol_address": "<string>"
}
},
"verified_accounts": [
{
"platform": "x",
"username": "<string>"
}
],
"power_badge": true,
"experimental": {
"deprecation_notice": "<string>",
"neynar_user_score": 123
},
"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,
"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>",
"signer": {
"object": "signer",
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
"status": "generated",
"signer_approval_url": "<string>",
"fid": 3,
"permissions": [
"WRITE_ALL"
]
},
"user": {
"object": "user",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"pro": {
"status": "subscribed",
"subscribed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"pfp_url": "<string>",
"profile": {
"bio": {
"text": "<string>",
"mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
}
],
"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>",
"state": "<string>",
"state_code": "<string>",
"country": "<string>",
"country_code": "<string>"
},
"radius": 1
},
"banner": {
"url": "<string>"
}
},
"follower_count": 123,
"following_count": 123,
"verifications": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"verified_addresses": {
"eth_addresses": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"sol_addresses": [
"<string>"
],
"primary": {
"eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"sol_address": "<string>"
}
},
"verified_accounts": [
{
"platform": "x",
"username": "<string>"
}
],
"power_badge": true,
"experimental": {
"deprecation_notice": "<string>",
"neynar_user_score": 123
},
"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
Success
The response is of type object
.
Was this page helpful?