Skip to main content

Get Order Amends

POST 
/private/OrderAmends

Retrieves an audit trail of amend transactions on the specified order. The list is ordered by ascending amend timestamp.

API Key Permissions Required: Orders and trades - Query open orders & trades or Orders and trades - Query closed orders & trades, depending on status of order.

Request​

Body

required
    nonce int64required

    Nonce used in construction of API-Sign header

    order_id string

    The Kraken order identifier for the amended order.

Responses​

The first entry contains the original order parameters and has amend_type of original.

Schema
    result object

    The amend transaction history.

    count integer

    The total count of new and amend transactions (i.e. includes the original order).

    amends object[]
  • Array [
    • amend_id string

    Kraken amend identifier

    amend_type string

    Possible values: [original, user, restated]

    The type of amend transaction:

    • • original: original order values on order entry.
    • • user: user requested amendment.
    • • restated: engine order maintenance amendment.
    order_qty string

    Order quantity in terms of the base asset.

    display_qty string

    The quantity show in the book for iceberg orders.

    remaining_qty string

    Remaining un-traded quantity on the order.

    limit_price string

    The limit price restriction on the order.

    trigger_price string

    The trigger price on trigger order types.

    reason string

    Description of the reason for this amend.

    post_only boolean

    Indicates if the transaction was restricted from taking liquidity.

    timestamp integer

    The UNIX timestamp for the amend transaction.

  • ]
Loading...