Logo
Admin API API Documentation

NEW v1.30.0 Archive Instrument

POST {{URL_ORIGIN}}/api/v2/instruments/:id/archive

This API allows to archiving of existing instrument

Please contact the Exberry team if you would like to enable it on your system.

In order to support a large number of instruments we introduce the ability to archive instruments.

This is an irreversible operation that should happen only in case the instrument is no longer in use permanently.

When an instrument is archived, you can still access historical financial information about it, including Orders, Order events, Trades, and Ops reports. You can also create a new instrument with the same symbol, but the archived instrument is no longer tradable.

Archived instruments will be served only in those places:

  • Reporting
    • Orders
    • Orders event
    • Trades
    • Operations
  • Reporting API:
    • v1/exchange.reporting/mp/orders
    • v2/exchange.reporting/mp/trades

In all other APIs, archived instruments will not be served.

Prior to archiving an instrument, it must first be disabled, in case this instrument is a leg of a strategy, the parent must be archived prior to its legs.

Archive Instrument- Error Codes

Code Message
1 Exchange is unavailable
100 Missing or invalid parameter: [FieldName]
101 [FieldName] not found
102 Disable the instrument before attempting to archive it
106 Archiving strategy [parentSymbol] is required
10001 Permission denied

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{}



Curl
curl -X POST 'URL_ORIGIN/api/v2/instruments/:id/archive'

ENDPOINTS