Neynar Documentation
Publish message
cURL
curl --request POST \
--url https://api.neynar.com/v2/farcaster/message/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: NEYNAR_API_DOCS' \
--data '{}'
Python
import requests
url = "https://api.neynar.com/v2/farcaster/message/"
payload = {}
headers = {
"x-api-key": "NEYNAR_API_DOCS",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
JavaScript (Fetch API)
const options = {
method: 'POST',
headers: {'x-api-key': 'NEYNAR_API_DOCS', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.neynar.com/v2/farcaster/message/', 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://api.neynar.com/v2/farcaster/message/",\
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([\
\
]),\
CURLOPT_HTTPHEADER => [\
"Content-Type: application/json",\
"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://api.neynar.com/v2/farcaster/message/"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
req.Header.Add("Content-Type", "application/json")
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://api.neynar.com/v2/farcaster/message/")
.header("x-api-key", "NEYNAR_API_DOCS")
.header("Content-Type", "application/json")
.body("{}")
.asString();
Ruby
require 'uri'
require 'net/http'
url = URI("https://api.neynar.com/v2/farcaster/message/")
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/json'
request.body = "{}"
response = http.request(request)
puts response.read_body
Response Codes
- 200: Success
- 400: Bad Request
- 500: Internal Server Error
Example Response
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}
Node.js SDK
SDK Method: publishMessageToFarcaster
Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.
Authorizations
- x-api-key
Type: string
Location: header
Default: NEYNAR_API_DOCS
Required: Yes
API key to authorize requests
Body
- Type: application/json
Description: The body is of typePublishMessageReqBody · object.
Response
- 200 Not Found
- Type: application/json
Description: Success - The response is of type
PublishMessageResponse · object.
- Type: application/json