Quickstart

Get started with OpenBits in three steps: get access, authenticate, and make your first API call.

1. Get your API key

Contact [email protected] for account access, then navigate to Dashboard > API Keys to create a key. Your key starts with ob_live_ and looks like:

ob_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Your account includes credits for API calls based on your plan.

2. Make your first call

# Install the CLI
npm install -g @openbits/cli

# Authenticate
openbits login --key ob_live_YOUR_KEY

# Look up a Twitter user
openbits call twitter/users/by/username/elonmusk

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

const response = await fetch('https://api.openbits.ai/twitter/v1/users/by/username/elonmusk', {
  headers: {
    'X-API-Key': 'ob_live_YOUR_KEY',
  },
})

const data = await response.json()
console.log(data)

import requests

response = requests.get(
    "https://api.openbits.ai/twitter/v1/users/by/username/elonmusk",
    headers={"X-API-Key": "ob_live_YOUR_KEY"},
)

print(response.json())

3. Check your response

A successful response looks like:

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

Check the x-openbits-credit-cost response header to see how many credits were used.

4. Check your balance

openbits balance

curl -X GET "https://api.openbits.ai/api/v1/credits/balance" \
  -H "X-API-Key: ob_live_YOUR_KEY"

Next steps

Authentication

Learn about API keys, org-scoped keys, and rotation.

Credits & Pricing

Understand the credit system, tiers, and volume discounts.

Twitter API

Explore all 21 Twitter endpoints with examples.

CLI Reference

Full CLI command reference.

AI Agents

Let your AI agent discover and call APIs autonomously.

Getting Started

Guides

AI Agents

CLI

Connectors

Quickstart

Quickstart

1. Get your API key

2. Make your first call

3. Check your response

4. Check your balance

Next steps

Authentication

Credits & Pricing

Twitter API

CLI Reference

AI Agents

​Quickstart

​1. Get your API key

​2. Make your first call

​3. Check your response

​4. Check your balance

​Next steps

Authentication

Credits & Pricing

Twitter API

CLI Reference

AI Agents

Quickstart

1. Get your API key

2. Make your first call

3. Check your response

4. Check your balance

Next steps