# Lobsters on Onekey

> 10 endpoints for Lobsters (10 stable, 0 beta), 1 to 5 credits each. Category: Messaging & communities. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/lobsters
Reference (Markdown): https://onekey.dev/docs/api/lobsters.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 10 mapped Lobsters endpoints return each:

- `author.username` (string): 9
- `content.createdAt` (ISO 8601 date): 9
- `content.text` (string): 9
- `content.id` (string): 8
- `content.url` (URL): 8
- `engagement.likes` (integer): 8
- `content.title` (string): 7
- `engagement.comments` (integer): 7
- `entity.name` (string): 2
- `author.id` (string): 1
- `entity.category` (string): 1
- `entity.description` (string): 1
- plus 4 platform-specific fields under `ext.`

## Endpoints

### lobsters.active

Lobsters stories with recent discussion.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lobsters/active` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.id`, `content.title`, `content.url`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `engagement.comments`, `ext.discussionUrl`
- Reference: https://onekey.dev/docs/api/lobsters/active.md

### lobsters.hottest

Lobsters front page (hottest stories).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lobsters/hottest` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.id`, `content.title`, `content.url`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `engagement.comments`
- Reference: https://onekey.dev/docs/api/lobsters/hottest.md

### lobsters.newest

Newest Lobsters stories.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lobsters/newest` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.id`, `content.title`, `content.url`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `engagement.comments`, `ext.discussionUrl`
- Reference: https://onekey.dev/docs/api/lobsters/newest.md

### lobsters.newest_page

Lobsters newest stories, paginated.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lobsters/newest_page?page=2` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `page` (string, optional, default 2): Page number
- Fields returned: `content.id`, `content.title`, `content.url`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `engagement.comments`, `ext.discussionUrl`
- Reference: https://onekey.dev/docs/api/lobsters/newest_page.md

### lobsters.story

A Lobsters story by short id.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/lobsters/story?id=q2rymh` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Story short id, e.g. q2rymh
- Fields returned: `content.id`, `content.title`, `content.url`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `engagement.comments`, `entity.name`, `ext.discussionUrl`
- Reference: https://onekey.dev/docs/api/lobsters/story.md

### lobsters.story_comments

Comments of a Lobsters story.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lobsters/story_comments?id=q2rymh` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Story short id, e.g. q2rymh
- Fields returned: `content.id`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `content.url`, `ext.depth`
- Reference: https://onekey.dev/docs/api/lobsters/story_comments.md

### lobsters.tag

Lobsters stories for a tag.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lobsters/tag?tag=rust` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `tag` (string, required): Lobsters tag, e.g. rust
- Fields returned: `content.id`, `content.title`, `content.url`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `engagement.comments`, `ext.discussionUrl`
- Reference: https://onekey.dev/docs/api/lobsters/tag.md

### lobsters.tags

All Lobsters tags.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lobsters/tags` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.name`, `entity.description`, `entity.category`, `ext.active`
- Reference: https://onekey.dev/docs/api/lobsters/tags.md

### lobsters.user

Fetch a Lobsters user profile.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/lobsters/user?username=jcs` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Lobsters username, e.g. jcs
- Fields returned: `author.id`, `author.username`, `content.text`, `content.createdAt`, `ext.karma`
- Reference: https://onekey.dev/docs/api/lobsters/user.md

### lobsters.user_stories

Stories submitted by a Lobsters user.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lobsters/user_stories?user=pushcx` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `user` (string, required): Lobsters username, e.g. pushcx
- Fields returned: `content.id`, `content.title`, `content.url`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `engagement.comments`, `ext.discussionUrl`
- Reference: https://onekey.dev/docs/api/lobsters/user_stories.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/lobsters/story?id=q2rymh" \
  -H "x-api-key: YOUR_API_KEY"
```