iBusAPI

How access works

Access is given to a project, not to a person: a project has an owner (an iBus account), groups of operations, keys, optional IP addresses and limits.

1. Application

Sign in to iBus and describe the project: what you are building, which data you need, the expected load, how you call the API and from which addresses. The e-mail of your account becomes the confirmed contact.

One open application at a time; the draft is kept while you write.

2. Review

The iBus team reads every application and may ask a question. You answer on the application's page, which also shows the status: draft, sent, in review, details needed, approved or declined.

There is no key before approval, and no review time is promised.

3. Project and keys

4. IP addresses

With an IP list, a request needs both the right key and an allowed address. With the restriction on and an empty list, every request is refused. Private and very wide networks are refused; a wide network needs an explicit confirmation.

If iBus set the restriction, changes go through a request on the project page.

5. Limits

WhoPer minute (burst)Per day, UTCPer month, UTCAt onceHeavy: per minute / day
Project, «trial»30 (10)1,00020,0002—
Project, «standard»120 (30)20,000400,0004—
Project, individual (example)120 (30)20,000400,00046 / 300
Without a key: older addresses only, per address (transition)60 (30)20,000400,000620 / 600

Day and month budgets reset at 00:00 UTC (02:00 or 03:00 in Israel, depending on the season). A refusal says which limit was reached and when to retry (Retry-After). Individual limits are set by iBus on request.

6. Pause and block

iBus can pause a project (its keys stay) or block it (all keys are revoked), always with a reason shown on the project page, where you can reply. Repeated violations, such as many wrong keys, lead to a short automatic pause; a long block is only a person's decision.

7. What is kept

Every refusal code and what to do: access errors.

Request accessDocumentation
API
↑ ↓ moveEnter openEsc close