For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
This endpoint creates an XLM Manage Buy 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
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Creates (or modifies an existing) XLM Buy Offer Request. Selling asset is the asset associated to the address identified by fromAddressId.
fromAddressIdstringRequiredformat: "uint64"
pricestringRequired
Price of 1 unit of buying in terms of selling, as a string representing a floating point number. For example, if you wanted to buy 30 XLM and sell 5 BTC, the price would be 5/30 = ‘0.1666667’
amountstringOptional
Amount of the buying asset to buy, 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
feeLimitstringOptional
buyingAssetIDstringOptional
Specify asset to be bought in the offer. Leave empty for XLM native
buyingAssetIssuerstringOptional
Specify asset to be bought in the offer. Leave Empty for XLM native
commentstringOptional
offerIDstringOptionalformat: "int64"
ID of the offer to be modified. If 0, a new offer is created
externalRequestIdstringOptional
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