api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "lookupStatus": {
          "description": "Whether the subreddit was found.",
          "enum": [
            "found",
            "not_found"
          ],
          "type": "string"
        },
        "metrics": {
          "description": "Subreddit metrics when available.",
          "nullable": true,
          "properties": {
            "subscribers": {
              "description": "Subscriber count when available.",
              "minimum": 0,
              "nullable": true,
              "type": "integer"
            },
            "weeklyActiveUsers": {
              "description": "Approximate weekly active users when available.",
              "minimum": 0,
              "nullable": true,
              "type": "integer"
            },
            "weeklyContributions": {
              "description": "Approximate weekly contributions when available.",
              "minimum": 0,
              "nullable": true,
              "type": "integer"
            }
          },
          "required": [
            "subscribers",
            "weeklyActiveUsers",
            "weeklyContributions"
          ],
          "type": "object"
        },
        "subreddit": {
          "description": "Subreddit details when available.",
          "nullable": true,
          "properties": {
            "advertiserCategory": {
              "description": "Advertiser category label when available.",
              "nullable": true,
              "type": "string"
            },
            "bannerUrl": {
              "description": "Subreddit banner image URL when available.",
              "nullable": true,
              "type": "string"
            },
            "createdAt": {
              "description": "Subreddit creation timestamp when available.",
              "nullable": true,
              "type": "string"
            },
            "description": {
              "description": "Subreddit description text when available.",
              "nullable": true,
              "type": "string"
            },
            "iconUrl": {
              "description": "Subreddit icon image URL when available.",
              "nullable": true,
              "type": "string"
            },
            "name": {
              "description": "Public subreddit name.",
              "type": "string"
            },
            "platform": {
              "description": "Social platform for this subreddit.",
              "enum": [
                "reddit"
              ],
              "type": "string"
            },
            "rules": {
              "description": "Subreddit rules text when available.",
              "nullable": true,
              "type": "string"
            },
            "submitText": {
              "description": "Submission guidance text shown to members when available.",
              "nullable": true,
              "type": "string"
            },
            "subredditId": {
              "description": "Stable subreddit identifier when available.",
              "type": "string"
            },
            "url": {
              "description": "Canonical public subreddit URL.",
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "platform",
            "name",
            "url",
            "description",
            "rules",
            "iconUrl",
            "bannerUrl",
            "createdAt"
          ],
          "type": "object"
        }
      },
      "required": [
        "lookupStatus",
        "subreddit",
        "metrics"
      ],
      "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"
}