reddit.posts.comments@v1

Reddit post comments

CommentList

Read one page of the current public comment forest and safe summaries of unexpanded replies for a known Post ID.

POST/v1/reddit/posts/comments

Chinese name: Reddit Post 评论 · 评论 · 列表
按 Post ID 分页读取当前公开评论树页面及未展开回复摘要。

Terminology: Post — 帖子

Use it when

Use it when one page of public thread context must feed an AI or fixed workflow.

Do not use it for

Do not use it for comment search or automatic recursive expansion of every reply branch.

Request parameters

FieldTypeConstraints and defaultsRequirement

Fieldpost_idstringpattern: "^(?:t3_)?[a-z0-9]+$"Required

Fieldsortstringenum: "CONFIDENCE" | "NEW" | "TOP" | "HOT" | "CONTROVERSIAL" | "OLD" | "RANDOM"Optional

FieldcursorstringminLength: 1Optional

Full request JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "post_id": {
      "type": "string",
      "pattern": "^(?:t3_)?[a-z0-9]+$"
    },
    "sort": {
      "type": "string",
      "enum": [
        "CONFIDENCE",
        "NEW",
        "TOP",
        "HOT",
        "CONTROVERSIAL",
        "OLD",
        "RANDOM"
      ]
    },
    "cursor": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "post_id"
  ],
  "additionalProperties": false
}

Static response example

application/json

{
  "code": 200,
  "request_id": "req_example_reddit_comments",
  "message": "success",
  "data": {
    "items": [
      {
        "id": "t1_comment_fixture",
        "post_id": "t3_1vpq8m8",
        "parent_id": "t3_1vpq8m8",
        "depth": 0,
        "child_count": 4,
        "body": "Public fixture comment",
        "created_at": "2026-08-26T00:00:00Z",
        "author": {
          "id": "t2_fixture",
          "name": "fixture"
        },
        "score": 5,
        "permalink": "/r/OpenAI/comments/1vpq8m8/example/comment_fixture/",
        "reddit_url": "https://www.reddit.com/r/OpenAI/comments/1vpq8m8/example/comment_fixture/",
        "is_removed": false,
        "is_score_hidden": false
      }
    ],
    "unexpanded_replies": [
      {
        "parent_id": "t1_comment_fixture",
        "depth": 1,
        "count": 4
      }
    ]
  },
  "page": {
    "next_cursor": null
  },
  "warnings": [],
  "meta": {
    "result_status": "complete",
    "balance_after": "0.98",
    "listing_id": "reddit.posts.comments",
    "version": "v1",
    "catalog_release_id": "catalog-production-2026-09-17.1",
    "price_book_version": "pricebook-production-2026-09-17.1",
    "charged_amount": "0.02",
    "currency": "CNY"
  }
}

Run live

Complete and empty results cost CNY 0.02; partial results and failures are not charged.

Request JSON body

Security check

Loading the security check…

6-digit code

Checking live execution status…

Execution result

// Result

Response contract

The field summary is for scanning; the full JSON Schema is the stable output contract.

FieldTypeConstraints and defaultsRequirement

Fieldcodenumberconst: 200Required

Fieldrequest_idstringNo additional constraintsRequired

Fieldmessagestringconst: "success"Required

FielddataobjectNo additional constraintsRequired

FieldpageobjectNo additional constraintsRequired

FieldwarningsarrayNo additional constraintsRequired

FieldmetaobjectNo additional constraintsRequired

Full response JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "const": 200
    },
    "request_id": {
      "type": "string"
    },
    "message": {
      "type": "string",
      "const": "success"
    },
    "data": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "post_id": {
                "type": "string"
              },
              "parent_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "depth": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "child_count": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "body": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "created_at": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "author": {
                "type": "object",
                "properties": {
                  "id": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "name": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "id",
                  "name"
                ],
                "additionalProperties": false
              },
              "score": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": -9007199254740991,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "permalink": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "reddit_url": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "is_removed": {
                "anyOf": [
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "is_score_hidden": {
                "anyOf": [
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "post_id",
              "parent_id",
              "depth",
              "child_count",
              "body",
              "created_at",
              "author",
              "score",
              "permalink",
              "reddit_url",
              "is_removed",
              "is_score_hidden"
            ],
            "additionalProperties": false
          }
        },
        "unexpanded_replies": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "parent_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "depth": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "count": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "parent_id",
              "depth",
              "count"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "items",
        "unexpanded_replies"
      ],
      "additionalProperties": false
    },
    "page": {
      "type": "object",
      "properties": {
        "next_cursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "next_cursor"
      ],
      "additionalProperties": false
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "listing_id": {
          "type": "string",
          "const": "reddit.posts.comments"
        },
        "version": {
          "type": "string",
          "const": "v1"
        },
        "catalog_release_id": {
          "type": "string",
          "minLength": 1
        },
        "price_book_version": {
          "type": "string",
          "minLength": 1
        },
        "result_status": {
          "type": "string",
          "enum": [
            "complete",
            "empty",
            "partial"
          ]
        },
        "charged_amount": {
          "type": "string"
        },
        "balance_after": {
          "type": "string"
        },
        "currency": {
          "type": "string",
          "const": "CNY"
        }
      },
      "required": [
        "listing_id",
        "version",
        "catalog_release_id",
        "price_book_version",
        "result_status",
        "charged_amount",
        "balance_after",
        "currency"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "code",
    "request_id",
    "message",
    "data",
    "page",
    "warnings",
    "meta"
  ],
  "additionalProperties": false
}

Known limitations

V1 returns one comment-forest page; unexpanded replies expose only parent, depth, and count summaries and cannot be expanded through this Listing.
A missing Post returned a successful empty forest; deleted, private, and inaccessible content must not be interpreted as never existing.

Integration example

REST (cURL)

curl -X POST https://api.dataxapi.com/v1/reddit/posts/comments \
  -H "Authorization: Bearer $DATAXAPI_API_KEY" \
  -H "Idempotency-Key: your-stable-intent-key" \
  -H "Content-Type: application/json" \
  -d '{"post_id":"t3_1vpq8m8","sort":"CONFIDENCE"}'

Exact MCP Preview (Codex config)

[mcp_servers.dataxapi]
url = "https://api.dataxapi.com/mcp"
bearer_token_env_var = "DATAXAPI_API_KEY"

The same API key exposes only the precise tools in its scope. Keep the key in an environment variable, never in the config file. Reuse an explicit idempotency_key for safe retries.

View client compatibility →

Catalog release: catalog-production-2026-09-17.1 · PriceBook: pricebook-production-2026-09-17.1