api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "page": {
          "description": "Pagination information for the current response.",
          "properties": {
            "hasMore": {
              "description": "Whether another page of results is available.",
              "type": "boolean"
            },
            "nextCursor": {
              "description": "Cursor to pass in the next request when another page exists.",
              "nullable": true,
              "type": "string"
            }
          },
          "required": [
            "nextCursor",
            "hasMore"
          ],
          "type": "object"
        },
        "posts": {
          "description": "Posts returned for this page.",
          "items": {
            "description": "A Reddit post in search results.",
            "properties": {
              "author": {
                "description": "Author username when available.",
                "nullable": true,
                "type": "string"
              },
              "bodyText": {
                "description": "Post body text when available.",
                "nullable": true,
                "type": "string"
              },
              "commentCount": {
                "description": "Comment count when available.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              },
              "createdAt": {
                "description": "ISO-8601 creation timestamp when available.",
                "nullable": true,
                "type": "string"
              },
              "id": {
                "description": "Stable post identifier.",
                "minLength": 1,
                "type": "string"
              },
              "isVideo": {
                "description": "Whether the post is a video post.",
                "type": "boolean"
              },
              "name": {
                "description": "Full post name when available.",
                "nullable": true,
                "type": "string"
              },
              "permalink": {
                "description": "Public permalink URL when available.",
                "nullable": true,
                "type": "string"
              },
              "score": {
                "description": "Post score when available.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              },
              "subreddit": {
                "description": "Subreddit name without a leading r/ when available.",
                "nullable": true,
                "type": "string"
              },
              "subredditPrefixedName": {
                "description": "Prefixed subreddit label such as r/example when available.",
                "nullable": true,
                "type": "string"
              },
              "subredditSubscriberCount": {
                "description": "Subreddit subscriber count when available.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              },
              "title": {
                "description": "Post title when available.",
                "nullable": true,
                "type": "string"
              },
              "upvoteRatio": {
                "description": "Upvote ratio between 0 and 1 when available.",
                "maximum": 1,
                "minimum": 0,
                "nullable": true,
                "type": "number"
              },
              "upvotes": {
                "description": "Upvote count when available.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              },
              "url": {
                "description": "Canonical public post URL when available.",
                "nullable": true,
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "title",
              "author",
              "subreddit",
              "subredditPrefixedName",
              "url",
              "permalink",
              "bodyText",
              "score",
              "upvotes",
              "upvoteRatio",
              "commentCount",
              "createdAt",
              "isVideo"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "query": {
          "description": "Search query string evaluated for this response.",
          "type": "string"
        },
        "totalResults": {
          "description": "Number of posts returned in this response.",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "query",
        "posts",
        "totalResults",
        "page"
      ],
      "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"
}