Overview
RedditFind Open API gives developers access to Community Discovery, Community Overview, and Monitoring capabilities. Use this page to locate the console, guides, API Reference, and OpenAPI JSON, then complete a standard REST API integration.
Default agent-facing copy stays in English on every locale.
Open these pages first
We recommend browsing these pages in this order before deciding which endpoint to call next.
Open /dashboard?tab=open-api to create and manage test/live tokens, then inspect key status, rotation, revocation, and usage.
Run the first working flow with the sample request to confirm authentication and request shape.
Review Bearer tokens, scopes, test/live environments, and idempotency rules.
Review the shared error shape, X-Request-Id, Retry-After, and X-RateLimit-* response headers.
Browse endpoints, fields, examples, and error codes by capability module.
Expose the standard spec to SDK generators, Postman, or other AI tools.
What each page solves
Go to the console to create an rf_test_ token first, then switch to rf_live_ after the integration passes.
Start with the API Reference overview, then choose between Community Discovery, Community Overview, Monitoring, Usage, and Access & Auth.
Open the endpoint detail page directly to inspect the request body, success response, field descriptions, and error codes.
Prefer the OpenAPI JSON; if you need an AI authorization loop, open the Skill Auth guidance in Authentication.
Choose endpoints by task
Use this when the user has product, audience, and scenario information but no subreddit shortlist yet; it generates candidate subreddits and reasoning.
Use this when the user already provides a subreddit and needs rules, content style, participation guidance, and risk analysis.
Use this when the user needs ongoing subreddit or query tracking; it creates monitoring jobs and reads hits.
Use this when you need to check whether credits are sufficient and how much resource usage already exists.
Start with GET /whoami to verify the token, environment, and scopes; list, create, rotate, or revoke API keys when needed.
How to call these endpoints
Follow these calling conventions first, then move into endpoint details.
Review Bearer tokens, scopes, test/live environments, and token security guidance.
Review the shared error shape, request tracing headers, rate-limit headers, and retry guidance.
If the caller is an AI agent, this page explains the CLI-first authorization loop.
- Every endpoint lives under /api/open/v1, and every request must send Authorization: Bearer <token>.
- Use rf_test_ for integration first, switch to rf_live_ for production traffic, and keep the two token types in separate environments.
- Before sending real business requests, call GET /whoami to check who owns the current token, which environment it belongs to, and which scopes it has.
- Write endpoints usually follow the async pattern POST /.../jobs -> GET /.../jobs/{job_id} -> GET /.../jobs/{job_id}/result.
- Manage keys through /keys: list existing keys or create, rotate, and revoke a specific key.
- Prefer sending an idempotency key on write requests to avoid duplicate jobs or duplicate billing during network retries.
- On errors, inspect error.code, error.message, and error.request_id first; when rate limited, also inspect Retry-After and X-RateLimit-*.
Common endpoint entrypoints
If you already know the target task, start directly from these endpoint detail pages.
Submit a Community Discovery task and get a job back asynchronously.
Submit a Community Overview task and get a job back asynchronously.
Create a continuous monitoring task and fetch hit results later.
Read credit balance and resource usage summary.
Confirm the user, environment, and key information behind the current token.
List the API keys for the current account.
Next actions
Create or inspect test/live tokens, then confirm key status and usage.
Start with GET /whoami to confirm the current token, environment, and scopes.
Use the cURL, TypeScript, or Python examples to complete the first request.
Browse every endpoint by module with fields, examples, and error details.