## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.neynar.com/llms.txt)

Use this file to discover all available pages before exploring further.

### Fetch UserData for a FID

#### cURL

```
curl --request GET \
  --url 'https://snapchain-api.neynar.com/v1/userDataByFid?user_data_type=USER_DATA_TYPE_PFP' \
  --header 'x-api-key: NEYNAR_API_DOCS'
```

#### Python

```
import requests

url = "https://snapchain-api.neynar.com/v1/userDataByFid?user_data_type=USER_DATA_TYPE_PFP"

headers = {"x-api-key": "NEYNAR_API_DOCS"}

response = requests.get(url, headers=headers)

print(response.text)
```

#### JavaScript (Fetch)

```
const options = {method: 'GET', headers: {'x-api-key': 'NEYNAR_API_DOCS'}};

fetch('https://snapchain-api.neynar.com/v1/userDataByFid?user_data_type=USER_DATA_TYPE_PFP', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

#### PHP

```
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://snapchain-api.neynar.com/v1/userDataByFid?user_data_type=USER_DATA_TYPE_PFP",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: NEYNAR_API_DOCS"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>
```

#### Go

```
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

url := "https://snapchain-api.neynar.com/v1/userDataByFid?user_data_type=USER_DATA_TYPE_PFP"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "NEYNAR_API_DOCS")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}
```

#### Java

```
HttpResponse<String> response = Unirest.get("https://snapchain-api.neynar.com/v1/userDataByFid?user_data_type=USER_DATA_TYPE_PFP")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();
```

#### Ruby

```
require 'uri'
require 'net/http'

url = URI("https://snapchain-api.neynar.com/v1/userDataByFid?user_data_type=USER_DATA_TYPE_PFP")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'

response = http.request(request)
puts response.read_body
```

### Response

#### 200

```json
{
  "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
  "hashScheme": "HASH_SCHEME_BLAKE3",
  "signature": "aSDinaTvuI8gbWludGxpZnk=",
  "signatureScheme": "SIGNATURE_SCHEME_ED25519",
  "signer": "<string>",
  "data": {
    "type": "MESSAGE_TYPE_CAST_ADD",
    "fid": 2,
    "timestamp": 48994466,
    "network": "FARCASTER_NETWORK_MAINNET",
    "userDataBody": {
      "type": "USER_DATA_TYPE_PFP",
      "value": "https://i.imgur.com/123abc.jpg"
    }
  }
}
```

```json
{
  "errCode": "<string>",
  "presentable": true,
  "name": "<string>",
  "code": 123,
  "details": "<string>",
  "metadata": {
    "errcode": [
      "<string>"
    ]
  }
}
```

### Authorizations

- **x-api-key**: (string) header required. Default: `NEYNAR_API_DOCS` - API key to authorize requests

### Query Parameters

- **fid**: (integer) required. The FID that's being requested.
- **user_data_type**: (enum<string>) default: `USER_DATA_TYPE_PFP` - The type of user data. Available options: `USER_DATA_TYPE_PFP`, `USER_DATA_TYPE_DISPLAY`, `USER_DATA_TYPE_BIO`, `USER_DATA_TYPE_URL`, `USER_DATA_TYPE_USERNAME`.
- **pageSize**: (integer) maximum number of messages to return in a single response.
- **reverse**: (boolean) reverse the sort order.
- **pageToken**: (string) fetch the next page if this parameter is not empty.

### Response

The requested UserData, examples:

- **hash**: (string) required. Example: "0xd2b1ddc6c88e865a33cb1a565e0058d757042974"
- **hashScheme**: (enum<string>) required. Default: `HASH_SCHEME_BLAKE3`
- **signature**: (string<byte>) required.
- **signatureScheme**: (enum<string>) required. Default: `SIGNATURE_SCHEME_ED25519`
- **signer**: (string) required.
- **data**: (object) required, represents a message that updates a user's profile metadata.