my_swap_status
uuid
The my_swap_status method returns the data of an atomic swap executed on an Komodo DeFi Framework API node.
| Structure | Type | Description |
|---|---|---|
| params uuid | string | the uuid of swap, typically received from the buy/sell call |
| Structure | Type | Description |
|---|---|---|
| events | array of objects | A standard SwapEvent object. Events which occurred for a swap. See Maker Events and Taker Events for more info. |
| success_events | array of strings | a list of events that gained a success swap state; the contents are listed in the order in which they should occur in the events array |
| error_events | array of strings | a list of events that fell into an error swap state; if at least 1 of the events happens, the swap is considered a failure |
| type | string | whether the node acted as a market Maker or Taker |
| uuid | string | swap uuid |
| gui | string (optional) | information about gui; copied from Komodo DeFi Framework API configuration in your MM2.json file |
| mm_version | string (optional) | Komodo DeFi Framework API version |
| maker_coin | string (optional) | ticker of maker coin |
| taker_coin | string (optional) | ticker of taker coin |
| maker_amount | string (numeric) | the amount of coins to be swapped by maker |
| taker_amount | string (numeric) | the amount of coins to be swapped by taker |
| maker_coin_usd_price | string (numeric) | the USD price of the maker coin at time of trade (if available) |
| taker_coin_usd_price | string (numeric) | the USD price of the taker coin at time of trade (if available) |
| my_info | object (optional) | this object maps event data to make displaying swap data in a GUI simpler (my_coin, my_amount, etc.) |
| recoverable | boolean | whether the swap can be recovered using the recover_funds_of_swap API command. Important note: The Komodo DeFi Framework API does not record the state regarding whether the swap was recovered or not. The Komodo DeFi Framework API allows as many calls to the recover_funds_of_swap method as necessary, in case of errors |
| my_order_uuid | string (uuid) | the uuid of order that matched to start the swap |
| is_finished | boolean | true indicates a swap that has completed. false indicates a swap that is in progress. |
| is_success | boolean | Not visible until swap completes. A value of false indicates a failed swap, and a value of true indicates the swap completed successfully. |
POST
my_swap_status{
"method": "my_swap_status",
"params": {
"uuid": "3d2286d1-1eef-487b-a07a-904f33034792"
},
"userpass": "RPC_UserP@SSW0RD"
}