Get Effective Price (Preview Market Order)

Get Effective Price (Preview Market Order)

GET https://api.swivel.exchange/v2/fillpreview?underlying=u&maturity=m&volume=v&vault=w&exit=e

This endpoint allows you to request a limit order payload that matches a given market order. Returns the effective price as well as orders for consumption.

Query Parameters

Name	Type	Description
underlying*	string	The underlying token being transacted. E.g. USDC, DAI, etc.,
maturity*	string	The maturity of market in unix seconds.
volume*	string	The amount of currency to use.
vault*	boolean	Indicates if an order is in relation to a initiating/exiting a vault or zcToken
exit*	boolean	Indicated if an order is an exit or an initiate

200

{
    "orders": [
        {
            "order": {
                "key": "0xa8181ff6e0bfa16130944d5add7220eed46f44796de7d4216728dde40376ac5e",
                "maker": "0x096Da21Ac79ae1EDbC69A07CE5c705E6c77Fec90",
                "underlying": "0x5592EC0cfb4dbc12D3aB100b257153436a1f0FEa",
                "vault": true,
                "exit": false,
                "principal": "107758620689655172413793",
                "premium": "10000000000000000000000",
                "maturity": "1669957199",
                "expiry": "1641371984"
            },
            "meta": {
                "price": "0.0928",
                "signature": "0xa4e8958193cf2cb9c70e4c4a7df9c3c7b68f89fd2f250d80e6bc9dbd9cba8c54415fb2f4d8da33c1d81d5a028233255b52adbf36bee3a2a929fb3ea3e735ff7a1c",
                "premiumAvailable": "10000000000000000000000",
                "principalAvailable": "107758620689655172413793",
                "previewFill": "1000",
                "sequence": 63593
            }
        }
    ],
    "effectivePrice": "0.092799999999999997156",
    "timestamp": 1640178873
}

400 Passed volume exceeds available

{
     "message": "passed volume exceeds available" 
}

400: Bad Request Passed volume exceeds the maximum number of orders allowed

{
    "message": "passed volume exceeds the maximum number of orders allowed"
}