Sorsa · Schema

User

JSON Schema for Sorsa common.User extracted from the OpenAPI v3 spec.

TwitterXSocial MediaData ExtractionReal-Time

Properties

Name Type Description
bio_urls array URLs found in the user's bio.
can_dm boolean Whether the account accepts direct messages.
created_at string Account creation date in ISO 8601 format.
description string Profile bio text.
display_name string User's display name.
favourites_count integer Total number of tweets this user has liked.
followers_count integer Number of accounts following this user.
followings_count integer Number of accounts this user follows.
id string Unique Twitter/X user ID.
location string Location string from the user's profile.
media_count integer Total number of media items posted by this user.
pinned_tweet_ids array IDs of the user's pinned tweets.
possibly_sensitive boolean Whether the account is flagged as possibly containing sensitive content.
profile_background_image_url string URL of the user's profile background image.
profile_image_url string URL of the user's avatar image.
protected boolean Whether the account's tweets are protected (private).
tweets_count integer Total number of tweets posted by this user.
username string Current Twitter/X handle (without @).
verified boolean Whether the account has a verified badge.
View JSON Schema on GitHub

JSON Schema

sorsa-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/sorsa/json-schema/sorsa-user-schema.json",
  "title": "User",
  "description": "JSON Schema for Sorsa common.User extracted from the OpenAPI v3 spec.",
  "properties": {
    "bio_urls": {
      "description": "URLs found in the user's bio.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "can_dm": {
      "description": "Whether the account accepts direct messages.",
      "example": false,
      "type": "boolean"
    },
    "created_at": {
      "description": "Account creation date in ISO 8601 format.",
      "example": "2009-06-02T20:12:29Z",
      "type": "string"
    },
    "description": {
      "description": "Profile bio text.",
      "example": "Bio text",
      "type": "string"
    },
    "display_name": {
      "description": "User's display name.",
      "example": "Elon Musk",
      "type": "string"
    },
    "favourites_count": {
      "description": "Total number of tweets this user has liked.",
      "example": 1200,
      "type": "integer"
    },
    "followers_count": {
      "description": "Number of accounts following this user.",
      "example": 100000,
      "type": "integer"
    },
    "followings_count": {
      "description": "Number of accounts this user follows.",
      "example": 500,
      "type": "integer"
    },
    "id": {
      "description": "Unique Twitter/X user ID.",
      "example": "44196397",
      "type": "string"
    },
    "location": {
      "description": "Location string from the user's profile.",
      "example": "Austin, TX",
      "type": "string"
    },
    "media_count": {
      "description": "Total number of media items posted by this user.",
      "example": 300,
      "type": "integer"
    },
    "pinned_tweet_ids": {
      "description": "IDs of the user's pinned tweets.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "possibly_sensitive": {
      "description": "Whether the account is flagged as possibly containing sensitive content.",
      "example": false,
      "type": "boolean"
    },
    "profile_background_image_url": {
      "description": "URL of the user's profile background image.",
      "example": "https://pbs.twimg.com/profile_banners/44196397/123",
      "type": "string"
    },
    "profile_image_url": {
      "description": "URL of the user's avatar image.",
      "example": "https://pbs.twimg.com/profile_images/123/photo.jpg",
      "type": "string"
    },
    "protected": {
      "description": "Whether the account's tweets are protected (private).",
      "example": false,
      "type": "boolean"
    },
    "tweets_count": {
      "description": "Total number of tweets posted by this user.",
      "example": 5000,
      "type": "integer"
    },
    "username": {
      "description": "Current Twitter/X handle (without @).",
      "example": "elonmusk",
      "type": "string"
    },
    "verified": {
      "description": "Whether the account has a verified badge.",
      "example": true,
      "type": "boolean"
    }
  },
  "type": "object"
}