OneBot Logo

OneBot API

Version 0.0.1
OpenAPI 3.1

The OneBot API provides endpoints for device registration, certificate management, and account balance tracking. This RESTful API uses standard HTTP methods and returns JSON responses.

Base URL
https://api.bot1.org
Content Type
application/json
Rate Limiting
1000 requests/hour

Authentication

Secure your API requests with our simple authentication system

How to Get Your API Key:

1.Go to Telegram and find @one_ibot

2.Open the bot and go to Settings

3.Tap on the "API" button

4.The bot will generate your unique API key

API Key Authentication

The OneBot API uses API key authentication. Include your API key in the request headers.

Header Format:

Authorization: YOUR_API_KEY
Example Request
curl --location 'https://api.bot1.org/balance' \
--header 'Authorization: YOUR_API_KEY'

API Endpoints

Explore our simple and powerful API endpoints for device management and certificate handling

GET
/balance
Get Balance

Retrieve your current account balance

No parameters required for this endpoint.

POST
/create_key
Create Key

Create one or more one-time keys for device registration with a specific plan

no_of_keys
number
form-data
Required

Number of keys to create (e.g., 1)

plan_id
string
form-data
Required

Plan ID for the keys (e.g., super0)

Available plans:

super0⚡ Super Plan | 0-Day Warranty
super40⚡ Super Plan | 30-Day Warranty
super90⚡ Super Plan | 90-Day Warranty
super180⚡ Super Plan | 180-Day Warranty
super300⚡ Super Plan | 300-Day Warranty
super_ipad⚡ Super Plan for iPad | 300-Day Warranty
developer_plan👨‍💻 Developer Plan | 0-Day Dev(JIT)Distro
developer_plan2👨‍💻 Developer Plan | 30-Day Dev(JIT)Distro
developer_planPPQ1👨‍💻 NO PPQ | 0-Day Dev(JIT)Distro
developer_planPPQ2👨‍💻 NO PPQ | 40-Day Dev(JIT)Distro
plan_superPPQ1⚡ NO PPQ | 0-Day Warranty
plan_superPPQ2⚡ NO PPQ | 40-Day Warranty
POST
/register
Register UDID

Register a device UDID using either your API key or a one-time key created via /create_key endpoint

udid
string
form-data
Required

Device UDID to register

register_plan
string
form-data
Optional

Registration plan (required only when using API key authorization)

Available plans:

super0⚡ Super Plan | 0-Day Warranty
super40⚡ Super Plan | 30-Day Warranty
super90⚡ Super Plan | 90-Day Warranty
super180⚡ Super Plan | 180-Day Warranty
super300⚡ Super Plan | 300-Day Warranty
super_ipad⚡ Super Plan for iPad | 300-Day Warranty
developer_plan👨‍💻 Developer Plan | 0-Day Dev(JIT)Distro
developer_plan2👨‍💻 Developer Plan | 30-Day Dev(JIT)Distro
developer_planPPQ1👨‍💻 NO PPQ | 0-Day Dev(JIT)Distro
developer_planPPQ2👨‍💻 NO PPQ | 40-Day Dev(JIT)Distro
plan_superPPQ1⚡ NO PPQ | 0-Day Warranty
plan_superPPQ2⚡ NO PPQ | 40-Day Warranty
GET
/certificate
Get Certificate

Retrieve certificates by UDID, certificate ID, or both

udid
string
query
Optional

Device UDID

certificate_id
string
query
Optional

Certificate ID