Target Volume
Buy a set amount of trading volume in USD for a token, at a price and a duration known before paying. The bot trades on the chosen pool until the volume target is reached.
Unlike Flexi, the client does not pick a budget, swap sizes or pace: Orbitt prices the order from the pool on-chain and the client picks a target and a speed.
Flow
GET /target-volume/pools/:address— list the token's pools and whether each one can take an order.GET /target-volume/targets— the volume targets on offer for that pool, each with its lowest price.GET /target-volume/quote— the speeds available for one target, each with its duration and price.POST /target-volume/initialize— create the order (or several, paid together). ReturnspaymentAddress,nTotalSolandnSolLeft.- Send
nSolLefttopaymentAddress, or callPOST /target-volume/payto send it from one of the user's wallets. - Follow the order with
GET /target-volume/bot/:iduntil it isFINISHEDorSTOPPED.
Prices are computed when the order is created and hold for
30 minutes. An order not fully paid by then expires (EXPIRED);
create a new one.
Targets and speeds
| Field | Values |
|---|---|
nTargetUsd | 20000, 50000, 100000, 200000, 500000, 1000000 |
eSpeed | FAST, 1H, 3H, 6H, 12H, 24H, 3D, 7D |
FAST runs as quickly as the pool allows; its duration differs per
order and is returned by quote as nDurationHours.
Not every speed is offered for every target: use the ones quote
returns.
Order status (sStatus)
sStatus | eStatus | Meaning |
|---|---|---|
WAITING_PAYMENT | 1 | Created, waiting for SOL at paymentAddress. |
STARTING | 1 | Payment received, the bot is being funded. |
ON_HOLD | 1 | Payment received, but the order is on hold. Contact support. |
ACTIVE | 2 | Trading. |
PAUSED | 2 | Trading is paused. Contact support. |
STOPPING | 2 | Stop requested: the bot sells what it holds and closes. |
FINISHED | 3 | Ended. |
STOPPED | 3 | Ended after a stop. |
CANCELLED | 4 | Cancelled before payment. |
EXPIRED | 4 | Not paid within 30 minutes. |
Availability
Target Volume is switched on per account. Where it is off, the
ordering endpoints (pools, targets, quote, initialize, pay)
answer 403 with { "message": "Target Volume is not available" }.
Reading, cancelling and stopping existing orders always works.
Singleton rule
A user can have one open (unpaid) order or order group at a time.
initialize answers 409 with the open order
until it is paid, cancelled or expired.
Endpoints
GET /target-volume/pools/:address— pools for a tokenGET /target-volume/targets— targets and lowest prices for a poolGET /target-volume/quote— speeds and prices for one targetPOST /target-volume/initialize— create an orderPOST /target-volume/pay— pay from an owned walletPATCH /target-volume/cancel/:id— cancel an unpaid orderPATCH /target-volume/stop/:id— stop a running orderGET /target-volume/bot/:id— one orderGET /target-volume/orders— the user's orders