api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "query": {
          "description": "Search query that was evaluated for this response.",
          "type": "string"
        },
        "totalUsers": {
          "description": "Number of users returned in this response.",
          "minimum": 0,
          "type": "integer"
        },
        "users": {
          "description": "Users returned for the search query.",
          "items": {
            "description": "A summarized public Threads user search result.",
            "properties": {
              "activeOnThreads": {
                "description": "Whether the account is reported as active on Threads.",
                "type": "boolean"
              },
              "avatarUrl": {
                "description": "Profile image URL for the user, when available.",
                "nullable": true,
                "type": "string"
              },
              "displayName": {
                "description": "Public display name shown for the user, when available.",
                "nullable": true,
                "type": "string"
              },
              "handle": {
                "description": "Threads username without the leading @.",
                "minLength": 1,
                "type": "string"
              },
              "onboardedToThreads": {
                "description": "Whether the account is reported as onboarded to Threads.",
                "type": "boolean"
              },
              "platform": {
                "description": "Social platform for this user.",
                "enum": [
                  "threads"
                ],
                "type": "string"
              },
              "platformUserId": {
                "description": "Threads user id as a string when available.",
                "type": "string"
              },
              "profileUrl": {
                "description": "Canonical public Threads profile URL.",
                "minLength": 1,
                "type": "string"
              },
              "verified": {
                "description": "Whether the user is marked as verified.",
                "type": "boolean"
              }
            },
            "required": [
              "platform",
              "handle",
              "displayName",
              "avatarUrl",
              "verified",
              "profileUrl"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "query",
        "users",
        "totalUsers"
      ],
      "type": "object"
    },
    "meta": {
      "description": "Metadata describing the request and billing outcome.",
      "properties": {
        "cached": {
          "description": "True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.",
          "type": "boolean"
        },
        "creditsCharged": {
          "description": "Credits charged for this request.",
          "minimum": 0,
          "type": "integer"
        },
        "requestId": {
          "description": "Unique request identifier for tracing this API call.",
          "minLength": 1,
          "type": "string"
        },
        "version": {
          "description": "Public API version that served the response.",
          "enum": [
            "v1"
          ],
          "type": "string"
        }
      },
      "required": [
        "requestId",
        "creditsCharged",
        "version"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}