What you get#
Onekey exposes Discourse as 18 endpoints behind one API key: 4 endpoints return one record (data is an object) and 14 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Discourse also works for the rest of the messaging & communities category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
about | About page data of a Discourse forum. | instance | 1 | stable |
badges | Badges of a Discourse forum. | instance | 5 | stable |
categories | Categories of a Discourse forum. | instance | 5 | stable |
category_topics | Topics in a Discourse category. | id*, instance | 5 | stable |
directory | User directory of a Discourse forum (most likes received). | instance | 5 | stable |
latest | Latest topics of a Discourse forum. | instance | 5 | stable |
latest_posts | Latest posts across a Discourse forum. | instance | 5 | stable |
search_posts | Search posts on a Discourse forum. | q*, instance | 5 | stable |
search_topics | Search topics on a Discourse forum. | q*, instance | 5 | stable |
tag_topics | Topics with a Discourse tag. | tag*, instance | 5 | stable |
tags | Tags of a Discourse forum. | instance | 5 | stable |
top | Top topics of a Discourse forum (past week). | instance | 5 | stable |
top_all | Top topics of a Discourse forum (all time). | instance | 5 | stable |
topic | A Discourse topic. | id*, instance | 1 | stable |
topic_posts | Posts (replies) of a Discourse topic. | id*, instance | 5 | stable |
user | A Discourse user's profile. | username*, instance | 1 | stable |
user_summary | Activity totals of a Discourse user. | username*, instance | 1 | stable |
user_topics | Topics created by a Discourse user. | username*, instance | 5 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls discourse.about (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/discourse/about" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Discourse, with the same names as on every other platform. The count is how many of its 18 mapped endpoints return the field; a field the source lacks is null, never missing. 12 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
engagement.likes | integer | 13 |
content.createdAt | ISO 8601 date | 12 |
content.id | string | 11 |
entity.name | string | 11 |
content.slug | string | 10 |
engagement.comments | integer | 10 |
engagement.views | integer | 9 |
content.title | string | 8 |
author.username | string | 7 |
content.updatedAt | ISO 8601 date | 7 |
content.text | string | 6 |
author.displayName | string | 5 |
author.id | string | 3 |
entity.id | string | 3 |
entity.description | string | 2 |
entity.slug | string | 1 |
The full schema is in Unified schema.
Pricing#
Discourse calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.