Search APIs
Loading…
← API Store
Social

Reddit

Reddit

Search subreddits

GET /reddit/v1/subreddit/search
Test this endpoint

Every response includes credits_used: the credits this call cost.

Each call costs 1 credits; failed calls are free. Run it in the console playground to see a live result.

Parameters

NameTypeDescription
qrequiredstring Example: python
cursorstringValue of `next_cursor` from the previous page.

Every endpoint also takes: raw、fields、fresh、output、records

{
  "cached": false,
  "communities": [
    {
      "description": "The largest Python community for Reddit! Stay up to date with the latest news, packages, and meta information relating to the Python program…",
      "icon": "https://styles.redditmedia.com/t5_2qh0y/styles/communityIcon_lctik80p96tg1.png?width=64&frame=1&auto=webp&s=92baaacc951d52b5071629852df033d5…",
      "id": "t5_2qh0y",
      "name": "Python",
      "nsfw": false,
      "position": 0,
      "prefixed_name": "r/Python",
      "quarantined": false,
      "tracking": {
        "action_info": {
          "position": 0,
          "relative_position": 0
        },
        "search": {
          "safe_search": "UNAVAILABLE",
          "structure_type": "search"
        },
        "subreddit": {
          "id": "t5_2qh0y",
          "name": "Python",
          "nsfw": false,
          "quarantined": false
        }
      },
      "url": "https://www.reddit.com/r/Python/",
      "weekly_contributions": 773,
      "weekly_visitors": 113853
    },
    {
      "description": "Subreddit for posting questions and asking for general advice about all topics related to learning python.",
      "icon": "https://styles.redditmedia.com/t5_2r8ot/styles/communityIcon_jwr5s7l5ici61.png?width=64&frame=1&auto=webp&s=5e8a6c0fb811bb5d907cb7227e0dd9a1…",
      "id": "t5_2r8ot",
      "name": "learnpython",
      "nsfw": false,
      "position": 1,
      "prefixed_name": "r/learnpython",
      "quarantined": false,
      "tracking": {
        "action_info": {
          "position": 1,
          "relative_position": 1
        },
        "search": {
          "safe_search": "UNAVAILABLE",
          "structure_type": "search"
        },
        "subreddit": {
          "id": "t5_2r8ot",
          "name": "learnpython",
          "nsfw": false,
          "quarantined": false
        }
      },
      "url": "https://www.reddit.com/r/learnpython/",
      "weekly_contributions": 1726,
      "weekly_visitors": 203339
    },
    "… 8 more"
  ],
  "count": 10,
  "credits_used": 1,
  "next_cursor": "eyJjYW5kaWRhdGVzX3JldHVybmVkIjoie1wic2VjdGlvbl8xX3BpcGVsaW5lXzBfZ2xvYmFsX21vZGlmaWVyc1wiOlwiMVwiLFwic2VjdGlvbl8xX3BpcGVsaW5lXzFfbG9jYWxfbW9k…",
  "query": "python"
}
Response fields (31)

Field paths and types observed in the sample response; the live response is authoritative.

$object
$.cachedboolean
$.communitiesarray
$.communities[]object | string
$.communities[].descriptionstring
$.communities[].iconstring
$.communities[].idstring
$.communities[].namestring
$.communities[].nsfwboolean
$.communities[].positioninteger
$.communities[].prefixed_namestring
$.communities[].quarantinedboolean
$.communities[].trackingobject
$.communities[].tracking.action_infoobject
$.communities[].tracking.action_info.positioninteger
$.communities[].tracking.action_info.relative_positioninteger
$.communities[].tracking.searchobject
$.communities[].tracking.search.safe_searchstring
$.communities[].tracking.search.structure_typestring
$.communities[].tracking.subredditobject
$.communities[].tracking.subreddit.idstring
$.communities[].tracking.subreddit.namestring
$.communities[].tracking.subreddit.nsfwboolean
$.communities[].tracking.subreddit.quarantinedboolean
$.communities[].urlstring
$.communities[].weekly_contributionsinteger
$.communities[].weekly_visitorsinteger
$.countinteger
$.credits_usedinteger
$.next_cursorstring
$.querystring