DOCUMENTATION
Quickstart
Request the catalog with cURL, Node.js or Python.
1. Create your key#
- In /account/developer enroll in an API plan, create a project and a key with catalog:read. The full secret is shown once. A content subscription does not replace an API plan.
- Keep your key in the server environment variable REDUXHUB_API_KEY.
- The examples use the local API at 127.0.0.1:1335. To use a mirror, replace that address in your client code with one from Domains & mirrors. Start the local API separately from the documentation.
2. Fetch the catalog#
GET /mods?limit=1 requires catalog:read and consumes one request unit. Choose your client:
cURL
cURL
API_BASE="http://127.0.0.1:1335/public/v1"
: "${REDUXHUB_API_KEY:?Set your server-side developer key}"
curl --fail-with-body --max-time 15 \
-H "Authorization: Bearer $REDUXHUB_API_KEY" \
-H "Accept: application/json" \
"$API_BASE/mods?limit=1"JavaScript · Node.js
JavaScript · Node.js
// Node.js: keep the key in the server environment, not browser storage.
const apiKey = process.env.REDUXHUB_API_KEY;
if (!apiKey) throw new Error("Set REDUXHUB_API_KEY");
const response = await fetch("http://127.0.0.1:1335/public/v1/mods?limit=1", {
headers: { Authorization: "Bearer " + apiKey, Accept: "application/json" },
redirect: "error",
signal: AbortSignal.timeout(15000),
});
const result = await response.json();
if (!response.ok) throw new Error("HTTP " + response.status + ": " + result.error?.code);
console.log(result);Python
Python
import json, os, urllib.request, urllib.error
class NoRedirect(urllib.request.HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
key = os.environ["REDUXHUB_API_KEY"]
opener = urllib.request.build_opener(urllib.request.ProxyHandler({}), NoRedirect())
request = urllib.request.Request(
"http://127.0.0.1:1335/public/v1/mods?limit=1",
headers={"Authorization": "Bearer " + key, "Accept": "application/json"},
)
try:
with opener.open(request, timeout=15) as response:
print(json.load(response))
except urllib.error.HTTPError as error:
print("HTTP", error.code) # Never print the key or a download ticket.3. Read the response#
GET /public/v1/mods?limit=1
HTTP response
HTTP/1.1 200
ratelimit-limit: 60
ratelimit-remaining: 59
ratelimit-reset: 60
x-request-id: b66165a1-110a-4909-a281-6faffa7432d9
cache-control: no-store
x-quota-limit: 10000
x-quota-remaining: 9997
x-quota-reset: 1797148615
content-type: application/json; charset=utf-8
{
"success": true,
"data": {
"items": [
{
"id": 2,
"name": "Example graphics preset",
"description": "Local documentation test fixture",
"category": "redux",
"type": "graphics",
"version": "legacy",
"project": "community",
"accessType": "free",
"price": {
"amountMinor": 0,
"currency": "RUB"
},
"publisherId": 1,
"previewUrl": null,
"downloads": 0,
"verified": false,
"createdAt": "2026-11-13T07:56:59.000Z",
"updatedAt": "2026-11-13T07:56:59.000Z",
"url": "http://localhost:5177/trigande/2"
}
],
"pagination": {
"limit": 1,
"nextCursor": "eyJ2IjoxLCJraW5kIjoibW9kcyIsImYiOiI0ZjUzY2RhMThjMmJhYTBjMDM1NGJiNWYiLCJpZCI6Mn0"
}
},
"meta": {
"requestId": "b66165a1-110a-4909-a281-6faffa7432d9",
"apiVersion": "v1"
}
}Mods are in data.items. Pass data.pagination.nextCursor as cursor together with the same filters and limit; never decode or modify a cursor. null means the end of the list. Use meta.requestId for diagnostics.
4. Quota and your next request#
- X-Quota-Limit and X-Quota-Remaining describe period units; X-Quota-Reset is a Unix timestamp in seconds. RateLimit-Reset is window seconds, not a Unix timestamp.
- GET /me/usage requires usage:read and consumes no request units, but counts against the shared account RPM limit.
- For failures use HTTP status and error.code; OAuth /oauth/token has its own standard OAuth JSON format. Actual failure responses are shown on Errors & retries.
- RU/EN refers to documentation: authored names and descriptions stay in their original language; no automatic translation is performed.