Neynar Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

Enabled notifications

cURL

curl --request GET \
  --url https://api.neynar.com/v2/farcaster/app_host/user/state/ \
  --header 'x-api-key: NEYNAR_API_DOCS'

Python

import requests

url = "https://api.neynar.com/v2/farcaster/app_host/user/state/"

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

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

print(response.text)

JavaScript

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

fetch('https://api.neynar.com/v2/farcaster/app_host/user/state/', 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://api.neynar.com/v2/farcaster/app_host/user/state/",
  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://api.neynar.com/v2/farcaster/app_host/user/state/"

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://api.neynar.com/v2/farcaster/app_host/user/state/")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/app_host/user/state/")

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 Codes

• 200
• 400
• 404
• 500

Example Responses

{
  "notifications_enabled": [
    {
      "domain": "<string>",
      "status": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "property": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "code": "<string>",
  "property": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "code": "<string>",
  "property": "<string>",
  "status": 123
}

Node.js SDK

SDK Method: appHostGetUserState Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

Authorizations

• x-api-key (string) - required, API key to authorize requests (default: NEYNAR_API_DOCS)

Query Parameters

• fid (integer) - required, The FID of the user (Required range: x >= 1)

Response

• 200 application/json
• notifications_enabled (object[]) - required, List of domains for which notifications are enabled for this user.

---

Sending Notifications
Specification
Debug Notifications
Client Events
appHostGetUserState