API Reference Overview

Base URL

https://api.openbits.ai

Authentication

Pass your API key in the X-API-Key header:

curl -H "X-API-Key: ob_live_YOUR_KEY" https://api.openbits.ai/twitter/v1/users/by/username/elonmusk

See Authentication Guide for details on key types and management.

URL Structure

Gateway endpoints (connectors) follow this pattern:

https://api.openbits.ai/{connector}/{version}/{path}

For example:

GET /twitter/v1/users/:id
GET /wallet/v1/balance/:address
GET /echo/v1/hello

Management endpoints use the /api/v1/ prefix:

GET /api/v1/credits/balance
POST /api/v1/api-keys
GET /api/v1/payments/plans

Response Format

Success Response

{
  "data": {
    "id": "44196397",
    "name": "Elon Musk",
    "username": "elonmusk"
  },
  "meta": {
    "requestId": "clxyz123abc",
    "cached": false
  }
}

Paginated Response

{
  "items": [...],
  "hasNextPage": true,
  "nextCursor": "abc123",
  "requestId": "clxyz123abc",
  "cached": false
}

Error Response

{
  "success": false,
  "error": {
    "statusCode": 401,
    "message": "Invalid API key",
    "code": "API_KEY_INVALID"
  }
}

Pagination

Paginated endpoints accept:

Parameter	Type	Default	Description
`cursor`	string	—	Pagination cursor from previous response
`page_size`	number	20	Items per page (1-100)

Use nextCursor from the response to fetch the next page. When hasNextPage is false, you’ve reached the end.

# First page
curl "https://api.openbits.ai/twitter/v1/users/44196397/tweets?page_size=10" \
  -H "X-API-Key: ob_live_YOUR_KEY"

# Next page
curl "https://api.openbits.ai/twitter/v1/users/44196397/tweets?page_size=10&cursor=abc123" \
  -H "X-API-Key: ob_live_YOUR_KEY"

Response Headers

Every response includes these headers:

Header	Description
`x-request-id`	Unique request identifier for debugging
`x-openbits-credit-cost`	Credits charged for this request
`x-ratelimit-limit`	Max requests in current window
`x-ratelimit-remaining`	Requests remaining in current window
`x-ratelimit-reset`	Unix timestamp when window resets
`x-ratelimit-scope`	`global` or `endpoint`
`retry-after`	Seconds to wait (only on 429 responses)

Available Connectors

Connector	Slug	Version	Endpoints	Status
Twitter API	`twitter`	v1	21	Production
Wallet API	`wallet`	v1	2	Mock (testing)
Echo API	`echo`	v1	2	Mock (testing)

See Twitter Connector for detailed endpoint documentation.

Overview

Users

Timelines

Social Graph

Tweets

Communities

Lists

Bulk Export

Admin Diagnostics

Admin

Discovery

API Reference Overview

API Reference Overview

Base URL

Authentication

URL Structure

Response Format

Success Response

Paginated Response

Error Response

Response Headers

Available Connectors

​API Reference Overview

​Base URL

​Authentication

​URL Structure

​Response Format

​Success Response

​Paginated Response

​Error Response

​Pagination

​Response Headers

​Available Connectors

API Reference Overview

Base URL

Authentication

URL Structure

Response Format

Success Response

Paginated Response

Error Response

Pagination

Response Headers

Available Connectors