api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "comments": {
          "description": "Comments returned for this page.",
          "items": {
            "properties": {
              "author": {
                "description": "Comment author username when available.",
                "nullable": true,
                "type": "string"
              },
              "createdAt": {
                "description": "When the comment was created (ISO-8601).",
                "format": "date-time",
                "nullable": true,
                "type": "string"
              },
              "depth": {
                "description": "Nesting depth of the comment in the thread.",
                "minimum": 0,
                "type": "integer"
              },
              "distinguished": {
                "description": "Distinguished comment label when available.",
                "nullable": true,
                "type": "string"
              },
              "id": {
                "description": "Stable identifier for the comment.",
                "minLength": 1,
                "type": "string"
              },
              "isSubmitter": {
                "description": "Whether the comment author is the post author.",
                "type": "boolean"
              },
              "locked": {
                "description": "Whether the comment is locked.",
                "type": "boolean"
              },
              "parentId": {
                "description": "Parent comment or post identifier when available.",
                "nullable": true,
                "type": "string"
              },
              "permalink": {
                "description": "Relative permalink path when available.",
                "nullable": true,
                "type": "string"
              },
              "renderedHtml": {
                "description": "Rendered HTML for the comment when available.",
                "nullable": true,
                "type": "string"
              },
              "replies": {
                "description": "Nested replies attached to this comment.",
                "properties": {
                  "items": {
                    "description": "Nested replies for this comment.",
                    "items": {
                      "properties": {
                        "author": {
                          "description": "Comment author username when available.",
                          "nullable": true,
                          "type": "string"
                        },
                        "createdAt": {
                          "description": "When the comment was created (ISO-8601).",
                          "format": "date-time",
                          "nullable": true,
                          "type": "string"
                        },
                        "depth": {
                          "description": "Nesting depth of the comment in the thread.",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "distinguished": {
                          "description": "Distinguished comment label when available.",
                          "nullable": true,
                          "type": "string"
                        },
                        "id": {
                          "description": "Stable identifier for the comment.",
                          "minLength": 1,
                          "type": "string"
                        },
                        "isSubmitter": {
                          "description": "Whether the comment author is the post author.",
                          "type": "boolean"
                        },
                        "locked": {
                          "description": "Whether the comment is locked.",
                          "type": "boolean"
                        },
                        "parentId": {
                          "description": "Parent comment or post identifier when available.",
                          "nullable": true,
                          "type": "string"
                        },
                        "permalink": {
                          "description": "Relative permalink path when available.",
                          "nullable": true,
                          "type": "string"
                        },
                        "renderedHtml": {
                          "description": "Rendered HTML for the comment when available.",
                          "nullable": true,
                          "type": "string"
                        },
                        "replies": {
                          "description": "Nested replies attached to this comment.",
                          "properties": {
                            "items": {
                              "description": "Further nested replies beyond the documented depth.",
                              "items": {
                                "nullable": true
                              },
                              "type": "array"
                            },
                            "page": {
                              "description": "Pagination state for nested replies.",
                              "properties": {
                                "hasMore": {
                                  "description": "Whether another page of comments or replies is available.",
                                  "type": "boolean"
                                },
                                "nextCursor": {
                                  "description": "Cursor to pass in the next request when more pages exist.",
                                  "nullable": true,
                                  "type": "string"
                                }
                              },
                              "required": [
                                "nextCursor",
                                "hasMore"
                              ],
                              "type": "object"
                            }
                          },
                          "required": [
                            "items",
                            "page"
                          ],
                          "type": "object"
                        },
                        "score": {
                          "description": "Comment score when available.",
                          "nullable": true,
                          "type": "integer"
                        },
                        "stickied": {
                          "description": "Whether the comment is stickied.",
                          "type": "boolean"
                        },
                        "text": {
                          "description": "Comment text.",
                          "type": "string"
                        },
                        "upvotes": {
                          "description": "Upvote count when available.",
                          "minimum": 0,
                          "nullable": true,
                          "type": "integer"
                        },
                        "url": {
                          "description": "Public comment URL when available.",
                          "nullable": true,
                          "type": "string"
                        }
                      },
                      "required": [
                        "id",
                        "url",
                        "permalink",
                        "parentId",
                        "author",
                        "text",
                        "renderedHtml",
                        "score",
                        "upvotes",
                        "createdAt",
                        "depth",
                        "isSubmitter",
                        "stickied",
                        "locked",
                        "distinguished",
                        "replies"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "page": {
                    "description": "Pagination state for nested replies.",
                    "properties": {
                      "hasMore": {
                        "description": "Whether another page of comments or replies is available.",
                        "type": "boolean"
                      },
                      "nextCursor": {
                        "description": "Cursor to pass in the next request when more pages exist.",
                        "nullable": true,
                        "type": "string"
                      }
                    },
                    "required": [
                      "nextCursor",
                      "hasMore"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "items",
                  "page"
                ],
                "type": "object"
              },
              "score": {
                "description": "Comment score when available.",
                "nullable": true,
                "type": "integer"
              },
              "stickied": {
                "description": "Whether the comment is stickied.",
                "type": "boolean"
              },
              "text": {
                "description": "Comment text.",
                "type": "string"
              },
              "upvotes": {
                "description": "Upvote count when available.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              },
              "url": {
                "description": "Public comment URL when available.",
                "nullable": true,
                "type": "string"
              }
            },
            "required": [
              "id",
              "url",
              "permalink",
              "parentId",
              "author",
              "text",
              "renderedHtml",
              "score",
              "upvotes",
              "createdAt",
              "depth",
              "isSubmitter",
              "stickied",
              "locked",
              "distinguished",
              "replies"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "lookupStatus": {
          "description": "Whether the post was resolved for this request.",
          "enum": [
            "found",
            "not_found"
          ],
          "type": "string"
        },
        "page": {
          "description": "Pagination information for this response.",
          "properties": {
            "hasMore": {
              "description": "Whether another page of comments or replies is available.",
              "type": "boolean"
            },
            "nextCursor": {
              "description": "Cursor to pass in the next request when more pages exist.",
              "nullable": true,
              "type": "string"
            }
          },
          "required": [
            "nextCursor",
            "hasMore"
          ],
          "type": "object"
        },
        "post": {
          "description": "Post details when available on this page.",
          "nullable": true,
          "properties": {
            "author": {
              "description": "Post author username when available.",
              "nullable": true,
              "type": "string"
            },
            "commentCount": {
              "description": "Reported comment count when available.",
              "minimum": 0,
              "nullable": true,
              "type": "integer"
            },
            "createdAt": {
              "description": "When the post was created (ISO-8601).",
              "format": "date-time",
              "nullable": true,
              "type": "string"
            },
            "id": {
              "description": "Stable post identifier.",
              "minLength": 1,
              "type": "string"
            },
            "locked": {
              "description": "Whether the post is locked.",
              "type": "boolean"
            },
            "over18": {
              "description": "Whether the post is marked over-18.",
              "type": "boolean"
            },
            "permalink": {
              "description": "Relative permalink path when available.",
              "nullable": true,
              "type": "string"
            },
            "score": {
              "description": "Post score when available.",
              "minimum": 0,
              "nullable": true,
              "type": "integer"
            },
            "stickied": {
              "description": "Whether the post is stickied.",
              "type": "boolean"
            },
            "subreddit": {
              "description": "Subreddit name without a leading r/.",
              "nullable": true,
              "type": "string"
            },
            "subredditNamePrefixed": {
              "description": "Prefixed subreddit name when available.",
              "nullable": true,
              "type": "string"
            },
            "title": {
              "description": "Post title. May be an empty string.",
              "type": "string"
            },
            "upvoteRatio": {
              "description": "Upvote ratio when available.",
              "nullable": true,
              "type": "number"
            },
            "url": {
              "description": "Canonical public post URL when available.",
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "id",
            "title",
            "url",
            "permalink",
            "subreddit",
            "subredditNamePrefixed",
            "author",
            "score",
            "upvoteRatio",
            "commentCount",
            "createdAt",
            "over18",
            "locked",
            "stickied"
          ],
          "type": "object"
        }
      },
      "required": [
        "lookupStatus",
        "post",
        "page",
        "comments"
      ],
      "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"
}