Neynar · Example Payload

Get User Best Friends

Returns the best friends of a user ranked by mutual affinity score based on interactions with each other.

User

Get User Best Friends is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

{
  "operationId": "get-user-best-friends",
  "method": "GET",
  "path": "/v2/farcaster/user/best_friends/",
  "summary": "Best friends",
  "description": "Returns the best friends of a user ranked by mutual affinity score based on interactions with each other.",
  "tags": [
    "User"
  ],
  "parameters": [
    {
      "name": "fid",
      "in": "query",
      "required": true,
      "description": "The FID of the user",
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Number of results to fetch",
      "schema": {
        "default": 3,
        "example": 5,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "description": "Pagination cursor",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/BestFriendsResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ZodError"
      },
      "example": null
    },
    "500": {
      "description": "Server Error",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}