User

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://neynar.com/schemas/User",
  "title": "User",
  "description": "Neynar Farcaster API schema for User",
  "properties": {
    "auth_addresses": {
      "items": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/EthAddress"
          },
          "app": {
            "$ref": "#/components/schemas/UserDehydrated"
          }
        },
        "required": [
          "address",
          "app"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "custody_address": {
      "$ref": "#/components/schemas/EthAddress"
    },
    "display_name": {
      "nullable": true,
      "type": "string"
    },
    "experimental": {
      "properties": {
        "deprecation_notice": {
          "type": "string"
        },
        "neynar_user_score": {
          "description": "Score that represents the probability that the account is not spam.",
          "format": "double",
          "type": "number"
        }
      },
      "required": [
        "neynar_user_score"
      ],
      "type": "object"
    },
    "fid": {
      "$ref": "#/components/schemas/Fid"
    },
    "follower_count": {
      "description": "The number of followers the user has.",
      "format": "int32",
      "type": "integer"
    },
    "following_count": {
      "description": "The number of users the user is following.",
      "format": "int32",
      "type": "integer"
    },
    "object": {
      "enum": [
        "user"
      ],
      "type": "string"
    },
    "pfp_url": {
      "description": "The URL of the user's profile picture",
      "nullable": true,
      "type": "string"
    },
    "pro": {
      "properties": {
        "expires_at": {
          "format": "date-time",
          "type": "string"
        },
        "status": {
          "description": "The subscription status of the user",
          "enum": [
            "subscribed",
            "unsubscribed"
          ],
          "type": "string"
        },
        "subscribed_at": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "status",
        "subscribed_at",
        "expires_at"
      ],
      "type": "object"
    },
    "profile": {
      "properties": {
        "banner": {
          "properties": {
            "url": {
              "description": "The URL of the user's banner image",
              "format": "uri",
              "type": "string"
            }
          },
          "type": "object"
        },
        "bio": {
          "properties": {
            "mentioned_channels": {
              "items": {
                "$ref": "#/components/schemas/ChannelDehydrated"
              },
              "type": "array"
            },
            "mentioned_channels_ranges": {
              "description": "Positions within the text (inclusive start, exclusive end) where each mention occurs.\nEach index within this list corresponds to the same-numbered index in the mentioned_channels list.",
              "items": {
                "$ref": "#/components/schemas/TextRange"
              },
              "type": "array"
            },
            "mentioned_profiles": {
              "items": {
                "$ref": "#/components/schemas/UserDehydrated"
              },
              "type": "array"
            },
            "mentioned_profiles_ranges": {
              "description": "Positions within the text (inclusive start, exclusive end) where each mention occurs.\nEach index within this list corresponds to the same-numbered index in the mentioned_profiles list.",
              "items": {
                "$ref": "#/components/schemas/TextRange"
              },
              "type": "array"
            },
            "text": {
              "type": "string"
            }
          },
          "required": [
            "text"
          ],
          "type": "object"
        },
        "live_at": {
          "properties": {
            "is_live": {
              "type": "boolean"
            },
            "updated_at": {
              "format": "date-time",
              "type": "string"
            },
            "url": {
              "description": "The URL of the user's current live activity",
              "type": "string"
            }
          },
          "required": [
            "url",
            "updated_at",
            "is_live"
          ],
          "type": "object"
        },
        "location": {
          "$ref": "#/components/schemas/Location"
        }
      },
      "required": [
        "bio"
      ],
      "type": "object"
    },
    "registered_at": {
      "format": "date-time",
      "type": "string"
    },
    "score": {
      "description": "Score that represents the probability that the account is not spam.",
      "format": "double",
      "type": "number"
    },
    "username": {
      "type": "string"
    },
    "verifications": {
      "items": {
        "$ref": "#/components/schemas/EthAddress"
      },
      "type": "array"
    },
    "verified_accounts": {
      "items": {
        "description": "Verified accounts of the user on other platforms, currently only X is supported.",
        "properties": {
          "platform": {
            "enum": [
              "x",
              "github"
            ],
            "type": "string"
          },
          "username": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "verified_addresses": {
      "properties": {
        "eth_addresses": {
          "description": "List of verified Ethereum addresses of the user sorted by oldest to most recent.",
          "items": {
            "$ref": "#/components/schemas/EthAddress"
          },
          "type": "array"
        },
        "primary": {
          "properties": {
            "eth_address": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/EthAddress"
                }
              ],
              "nullable": true
            },
            "sol_address": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/SolAddress"
                }
              ],
              "nullable": true
            }
          },
          "required": [
            "eth_address",
            "sol_address"
          ],
          "type": "object"
        },
        "sol_addresses": {
          "description": "List of verified Solana addresses of the user sorted by oldest to most recent.",
          "items": {
            "$ref": "#/components/schemas/SolAddress"
          },
          "type": "array"
        }
      },
      "required": [
        "eth_addresses",
        "sol_addresses",
        "primary"
      ],
      "type": "object"
    },
    "viewer_context": {
      "$ref": "#/components/schemas/UserViewerContext"
    }
  },
  "required": [
    "object",
    "fid",
    "username",
    "custody_address",
    "registered_at",
    "profile",
    "follower_count",
    "following_count",
    "verifications",
    "auth_addresses",
    "verified_addresses",
    "verified_accounts"
  ],
  "type": "object"
}