Create an XLM Manage Sell Offer request or Create Passive Sell Offer request

post

https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/xlm/sell_offer

This endpoint creates an XLM Manage Sell Offer or Create Passive Sell Offer request.
Required role: RequestCreator.
This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute

Body Params

Creates (or modifies an existing) XLM Sell Offer Request. Selling asset is the asset associated to the address identified by fromAddressId.

amount

string

Amount of the selling asset to sell, in the smallest currency unit, based on the currency decimals. For example, 1 corresponds to 1 'stroop' (one ten-millionth of XLM), and 1 XLM corresponds to 10000000 (7 decimals). If set to 0, deletes the offer identified by offerID

feeLimit

string

fromAddressId

string

required

buyingAssetID

string

Specify asset to be bought in the offer. Leave empty for XLM native

buyingAssetIssuer

string

Specify asset to be bought in the offer. Leave Empty for XLM native

comment

string

price

string

required

Price of 1 unit of selling in terms of buying, as a string representing a floating point number. For example, if you wanted to sell 30 XLM and buy 5 BTC, the price would be 5/30 = '0.1666667'

offerID

string

ID of the offer to be modified. If 0, a new offer is created. Cannot be set if isPassive is true

isPassive

boolean

If true, creates a Passive Sell offer that will not consume a counter offer that exactly matches this offer. This is useful for offers meant to be 1:1 exchanges for path payments

externalRequestId

string

Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.