Skip to content
Scrappa Get API key
Reddit API 1 credit/request

Reddit Autocomplete API Documentation

GET https://scrappa.co/api/reddit/autocomplete

Reddit Autocomplete API completes a subreddit name from a prefix. It returns up to 25 subreddits with the same fields as the subreddit search.

Reddit Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/reddit/autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "prog",
        "subreddits": [
            {
                "id": "2tex6",
                "url": "https://www.reddit.com/r/ProgrammerHumor/",
                "name": "ProgrammerHumor",
                "type": "public",
                "title": "memesAndJokesAboutEverythingProgrammingAndCS",
                "over_18": false,
                "fullname": "t5_2tex6",
                "icon_url": "https://styles.redditmedia.com/t5_2tex6/styles/communityIcon_70ds7qqgfr8b1.png?width=256&s=66774572524b31ccfe245f6f450a625c1f445ece",
                "language": "en",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

2 optional filters available.

query string Required

Name prefix, up to 100 characters. Example: prog.

Example value coffee shops
limit integer Optional

Items, 1 to 25 (default 10). Example: 10.

Example value 10
nsfw boolean Optional

true to include adult subreddits (default false). Example: false.

Example value true

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "query": "prog",
        "subreddits": [
            {
                "id": "2tex6",
                "url": "https://www.reddit.com/r/ProgrammerHumor/",
                "name": "ProgrammerHumor",
                "type": "public",
                "title": "memesAndJokesAboutEverythingProgrammingAndCS",
                "over_18": false,
                "fullname": "t5_2tex6",
                "icon_url": "https://styles.redditmedia.com/t5_2tex6/styles/communityIcon_70ds7qqgfr8b1.png?width=256&s=66774572524b31ccfe245f6f450a625c1f445ece",
                "language": "en",
                "key_color": "#ff8717",
                "banner_url": "https://styles.redditmedia.com/t5_2tex6/styles/bannerBackgroundImage_z6ejudtdz7p41.png?width=4000&s=9e33bf27ecab480bc284b0d439ba9565668e2131",
                "created_at": "2012-01-22T13:11:51+00:00",
                "quarantine": false,
                "created_utc": 1327237911,
                "description": "> Not everybody understands the humor of programmers.\n\n###Filters\n\n* [All posts](http://www.reddit.com/r/ProgrammerHumor/#www)\n* [No meme...",
                "subscribers": 4773451,
                "allows_polls": false,
                "wiki_enabled": true,
                "allows_images": true,
                "allows_videos": false,
                "primary_color": "#ff4500",
                "submission_type": "link",
                "allows_galleries": true,
                "spoilers_enabled": true,
                "public_description": "For anything funny related to programming and software development."
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter or a value is invalid. This response is not billable.

{
    "errors": {
        "query": [
            "The query field is required."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

Reddit could not be reached or returned data that does not match the request. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Reddit could not be reached. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.