Neynar Documentation

Validate signed message

cURL

curl --request POST \
  --url https://snapchain-api.neynar.com/v1/validateMessage \
  --header 'Content-Type: application/octet-stream' \
  --header 'x-api-key: NEYNAR_API_DOCS' \
  --data '"<string>"'

Python

import requests

url = "https://snapchain-api.neynar.com/v1/validateMessage"

payload = "<string>"
headers = {
    "x-api-key": "NEYNAR_API_DOCS",
    "Content-Type": "application/octet-stream"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {'x-api-key': 'NEYNAR_API_DOCS', 'Content-Type': 'application/octet-stream'},
  body: JSON.stringify('<string>')
};

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

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://snapchain-api.neynar.com/v1/validateMessage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode('<string>'),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/octet-stream",
    "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"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://snapchain-api.neynar.com/v1/validateMessage"

payload := strings.NewReader("\"<string>\"")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
    req.Header.Add("Content-Type", "application/octet-stream")

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

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

fmt.Println(string(body))
}

Java (Unirest)

HttpResponse<String> response = Unirest.post("https://snapchain-api.neynar.com/v1/validateMessage")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .header("Content-Type", "application/octet-stream")
  .body("\"<string>\"")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://snapchain-api.neynar.com/v1/validateMessage")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'
request["Content-Type"] = 'application/octet-stream'
request.body = "\"<string>\""

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

Response Example

{
  "valid": true,
  "message": {
    "data": {
      "fid": 2,
      "timestamp": 48994466,
      "network": "FARCASTER_NETWORK_MAINNET",
      "castAddBody": {
        "embedsDeprecated": [
          "<string>"
        ],
        "mentions": [
          2
        ],
        "text": "<string>",
        "mentionsPositions": [
          123
        ],
        "embeds": [
          {
            "castId": {
              "fid": 2,
              "hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
            }
          }
        ],
        "parentCastId": {
          "fid": 2,
          "hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
        },
        "parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
      },
      "type": "MESSAGE_TYPE_CAST_ADD"
    },
    "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
    "hashScheme": "HASH_SCHEME_BLAKE3",
    "signature": "aSDinaTvuI8gbWludGxpZnk=",  
    "signatureScheme": "SIGNATURE_SCHEME_ED25519",
    "signer": "<string>"
  }
}

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

Authorizations

Body

A Message is a delta operation on the Farcaster network. The message protobuf is an envelope that wraps a MessageData object and contains a hash and signature which can verify its authenticity. The body is of type file.

Response

A successful response.