Getting Started

The RedShip API lets you programmatically access and manage your inbox (opportunities) found on Reddit.

Authentication

All API requests require an API key passed via the Authorization header.

Authorization: Bearer rsp_your_api_key_here

Creating an API Key

1. Go to Settings → API tab in your dashboard
2. Click Create Key and give it a name
3. Copy the key — it will only be shown once

Key Format

API keys are prefixed with rsp_ for easy identification (e.g. rsp_a1b2c3d4e5f6...).

Base URL

https://redship.io/api/v1

Endpoints

Response Format

All responses return JSON with a data field:

{
"data": { ... }
}

List endpoints also include pagination info:

{
"data": [...],
"count": 42,
"limit": 50,
"offset": 0
}

Error Handling

Errors return an error field with an HTTP status code:

{
"error": "Unauthorized"
}

Rate Limits

Please keep requests reasonable. Excessive usage may be throttled.