Neynar Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

Search mini apps

cURL

curl --request GET \
  --url 'https://api.neynar.com/v2/farcaster/frame/search/?limit=20' \
  --header 'x-api-key: NEYNAR_API_DOCS'

import requests

url = "https://api.neynar.com/v2/farcaster/frame/search/?limit=20"

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

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

print(response.text)

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

fetch('https://api.neynar.com/v2/farcaster/frame/search/?limit=20', 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/frame/search/?limit=20",
  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;
}
?>

package main

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

func main() {

url := "https://api.neynar.com/v2/farcaster/frame/search/?limit=20"

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))
}

HttpResponse<String> response = Unirest.get("https://api.neynar.com/v2/farcaster/frame/search/?limit=20")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/frame/search/?limit=20")

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 Structure

{
  "frames": [
    {
      "frames_url": "<string>",
      "image": "<string>",
      "version": "<string>",
      "author": {
        "auth_addresses": [
          {
            "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "app": {
              "fid": 3,
              "object": "user_dehydrated",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "display_name": "<string>",
              "pfp_url": "<string>",
              "score": 123,
              "username": "<string>"
            }
          }
        ],
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "fid": 3,
        "follower_count": 123,
        "following_count": 123,
        "object": "user",
        "profile": {
          "bio": {
            "text": "<string>",
            "mentioned_channels": [{
              "id": "<string>",
              "name": "<string>",
              "object": "channel_dehydrated",
              "image_url": "<string>",
              "viewer_context": {
                "following": true
              }
            }],
            "mentioned_channels_ranges": [{
              "end": 1,
              "start": 1
            }],
            "mentioned_profiles": [{
              "fid": 3,
              "object": "user_dehydrated",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "display_name": "<string>",
              "pfp_url": "<string>",
              "score": 123,
              "username": "<string>"
            }],
            "mentioned_profiles_ranges": [{
              "end": 1,
              "start": 1
            }]
          },
          "banner": {
            "url": "<string>"
          },
          "live_at": {
            "is_live": true,
            "updated_at": "2023-11-07T05:31:56Z",
            "url": "<string>"
          },
          "location": {
            "latitude": 0,
            "longitude": 0,
            "address": {
              "city": "<string>",
              "country": "<string>",
              "country_code": "<string>",
              "state": "<string>",
              "state_code": "<string>"
            },
            "radius": 1
          }
        },
        "registered_at": "2023-11-07T05:31:56Z",
        "username": "<string>",
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_accounts": [{
          "username": "<string>"
        }],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "sol_address": "<string>"
          },
          "sol_addresses": [
            "<string>"
          ]
        },
        "display_name": "<string>",
        "experimental": {
          "neynar_user_score": 123,
          "deprecation_notice": "<string>"
        },
        "pfp_url": "<string>",
        "pro": {
          "expires_at": "2023-11-07T05:31:56Z",
          "subscribed_at": "2023-11-07T05:31:56Z"
        },
        "score": 123,
        "viewer_context": {
          "blocked_by": true,
          "blocking": true,
          "followed_by": true,
          "following": true
        }
      },
      "manifest": {
        "account_association": {
          "header": "<string>",
          "payload": "<string>",
          "signature": "<string>"
        },
        "frame": {
          "home_url": "<string>",
          "icon_url": "<string>",
          "name": "<string>",
          "button_title": "<string>",
          "description": "<string>",
          "hero_image_url": "<string>",
          "image_url": "<string>",
          "noindex": true,
          "og_description": "<string>",
          "og_image_url": "<string>",
          "og_title": "<string>",
          "primary_category": "<string>",
          "screenshot_urls": [
            "<string>"
          ],
          "splash_background_color": "<string>",
          "splash_image_url": "<string>",
          "subtitle": "<string>",
          "tagline": "<string>",
          "tags": [
            "<string>"
          ],
          "webhook_url": "<string>"
        },
        "miniapp": {
          "home_url": "<string>",
          "icon_url": "<string>",
          "name": "<string>",
          "button_title": "<string>",
          "description": "<string>",
          "hero_image_url": "<string>",
          "image_url": "<string>",
          "noindex": true,
          "og_description": "<string>",
          "og_image_url": "<string>",
          "og_title": "<string>",
          "primary_category": "<string>",
          "screenshot_urls": [
            "<string>"
          ],
          "splash_background_color": "<string>",
          "splash_image_url": "<string>",
          "subtitle": "<string>",
          "tagline": "<string>",
          "tags": [
            "<string>"
          ],
          "webhook_url": "<string>"
        }
      },
      "metadata": {
        "html": {
          "favicon": "<string>",
          "modifiedTime": "<string>",
          "oembed": {
            "html": "<string>",
            "type": "rich",
            "version": "<string>",
            "author_name": "<string>",
            "author_url": "<string>",
            "cache_age": "<string>",
            "height": 123,
            "provider_name": "<string>",
            "provider_url": "<string>",
            "thumbnail_height": 123,
            "thumbnail_url": "<string>",
            "thumbnail_width": 123,
            "title": "<string>",
            "width": 123
          },
          "ogArticleAuthor": "<string>",
          "ogArticleExpirationTime": "<string>",
          "ogArticleModifiedTime": "<string>",
          "ogArticlePublishedTime": "<string>",
          "ogArticlePublisher": "<string>",
          "ogArticleSection": "<string>",
          "ogArticleTag": "<string>",
          "ogAudio": "<string>",
          "ogAudioSecureURL": "<string>",
          "ogAudioType": "<string>",
          "ogAudioURL": "<string>",
          "ogAvailability": "<string>",
          "ogDate": "<string>",
          "ogDescription": "<string>",
          "ogDeterminer": "<string>",
          "ogEpisode": "<string>",
          "ogImage": [{
              "url": "<string>",
              "alt": "<string>",
              "height": "<string>",
              "type": "<string>",
              "width": "<string>"
            }],
          "ogLocale": "<string>",
          "ogLocaleAlternate": "<string>",
          "ogLogo": "<string>",
          "ogMovie": "<string>",
          "ogPriceAmount": "<string>",
          "ogPriceCurrency": "<string>",
          "ogProductAvailability": "<string>",
          "ogProductCondition": "<string>",
          "ogProductPriceAmount": "<string>",
          "ogProductPriceCurrency": "<string>",
          "ogProductRetailerItemId": "<string>",
          "ogSiteName": "<string>",
          "ogTitle": "<string>",
          "ogType": "<string>",
          "ogUrl": "<string>",
          "ogVideo": [{
              "url": "<string>",
              "height": "<string>",
              "type": "<string>",
              "width": "<string>"
            }],
          "ogVideoActor": "<string>",
          "ogVideoActorId": "<string>",
          "ogVideoActorRole": "<string>",
          "ogVideoDirector": "<string>",
          "ogVideoDuration": "<string>",
          "ogVideoOther": "<string>",
          "ogVideoReleaseDate": "<string>",
          "ogVideoSecureURL": "<string>",
          "ogVideoSeries": "<string>",
          "ogVideoTag": "<string>",
          "ogVideoTvShow": "<string>",
          "ogVideoWriter": "<string>",
          "ogWebsite": "<string>",
          "updatedTime": "<string>"
        }
      },
      "title": "<string>"
    }
  ],
  "next": {
    "cursor": "<string>"
  }
}

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