Listing capacity
How to put unused credits on the book, and what the gateway may and may not do with your key.
Check your terms
Whether you may share or resell capacity depends on your provider's terms and on your plan. Read them first. A market only opens for a provider where its terms permit it, and you confirm that you have the right to list each time you connect a key.
Create a listing
- Connect a provider key. Create a dedicated key for OrbAPI if your provider supports more than one.
- The gateway reads your remaining allotment and reset date from the provider.
- Set the units to list, a discount to list price and a hard cap.
- Open the listing. It appears on the book at once.
| Field | Meaning |
|---|---|
| Units | How much of your remaining allotment to offer. |
| Discount | Your ask, as a percentage under list price. Between 20% and 80%. |
| Cap | The most the gateway may consume. Never exceeded. |
| Reserve | Units held back for your own use. The listing pauses if your balance nears it. |
| Auto-deepen | Optional. Increases the discount as the reset date approaches. |
Lifecycle
Draft
Key connected, not yet listed
Open
On the book, filling
Paused
Off the book, kept for later
Closed
Cap hit, reset reached or revoked
Pausing is instant for new requests. Requests already in flight complete and are paid. A closed listing deletes the stored key.
What the gateway does
- Calls only the endpoints of the market you listed in.
- Stops at your cap, including under concurrent load.
- Never shows your key to a buyer, in a response or in a log.
- Pauses your listing if the provider starts returning auth or quota errors.
More detail is on the security page.