Register New User
Register new account
Farcaster API V2
- User
- Fetch User Information
- Fetch User's Casts
- Register New User
- Update User Profile
- GETFetch authorization url
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Follows
- Storage
- Mini Apps
- Agents
- Fname
- Webhook
- Action
- Mute
- Block
- Ban
- Onchain
- Login
- Metrics
Onchain
Farcaster Hub API
- Info
- Casts
- Reactions
- Links
- UserData
- Fids
- Storage
- Usernames
- Verifications
- OnChainEvents
- Message
- HubEvents
Neynar SDK
- Getting Started with Neynar NodeJS SDK
- SDK v1 to v2 migration guide
Register New User
Register new account
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.
POST
/
farcaster
/
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": "0xe0cd4da80fb30d59e3ce5a10768c35043bc31487362977cf0a3acf15338a730f4aa329568055c943d777dd81fcb60292f15fc0bcf644da1943b6aa0b3ea9bdcf1b",
"fid": 321518,
"requested_user_custody_address": "0x2c57e688154C082955cF205F4A335E852D3e25f1",
"deadline": 1707371935,
"fname": "desired_fname"
}'
{
"success": true,
"message": "<string>",
"signer": {
"object": "signer",
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"public_key": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"status": "generated",
"signer_approval_url": "<string>",
"fid": 3,
"permissions": [
"WRITE_ALL"
]
},
"user": {
"object": "user",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"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>"
}
}
},
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
}
Related doc: Create new Farcaster account
Authorizations
API key to authorize requests
Body
application/json
Response
200
application/json
Successful operation.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.neynar.com/v2/farcaster/user \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"signature": "0xe0cd4da80fb30d59e3ce5a10768c35043bc31487362977cf0a3acf15338a730f4aa329568055c943d777dd81fcb60292f15fc0bcf644da1943b6aa0b3ea9bdcf1b",
"fid": 321518,
"requested_user_custody_address": "0x2c57e688154C082955cF205F4A335E852D3e25f1",
"deadline": 1707371935,
"fname": "desired_fname"
}'
{
"success": true,
"message": "<string>",
"signer": {
"object": "signer",
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"public_key": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"status": "generated",
"signer_approval_url": "<string>",
"fid": 3,
"permissions": [
"WRITE_ALL"
]
},
"user": {
"object": "user",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"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>"
}
}
},
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
}