Public API

time

Retrieves the current time (in ms). This API endpoint can be used to check the clock skew between your software and Deribit's systems.

HTTP usage: GET /api/v1/public/time

Websocket usage: {"action": "/api/v1/public/time"}

Example

// HTTP:
//   GET /api/v1/public/time
// Websocket:
//   {"action": "/api/v1/public/time"}

{
    "result":1528814188150
}

setheartbeat

Signals the Websocket connection to send and request heartbeats. Heartbeats can be used to detect stale connections. This API endpoint cannot be used over HTTP.

When heart beats have been set up, the API server will send heartbeat messages and test_request messages. Your software should respond test_request messages by sending a /api/v1/public/test request. If your software fails to do so, the API server will close the request. If your account is configured to cancel on disconnect, any orders opened over the connection will be cancelled.

Websocket usage: {"action": "/api/v1/public/setheartbeat", "arguments": {...}}

Arguments

Response

This endpoint returns an empty message (i.e. without result field).

Example

// Websocket:
//   {"action": "/api/v1/public/setheartbeat", 
//    "arguments": {"interval": 60}}

{
    ...
}

cancelheartbeat

Signals the Websocket connection to not send or request heartbeats. This API endpoint cannot be used over HTTP.

When heart beats have been set up, the API server will send heartbeat messages and test_request messages. Your software should respond test_request messages by sending a /api/v1/public/test request. If your software fails to do so, the API server will close the request. If your account is configured to cancel on disconnect, any orders opened over the connection will be cancelled.

This API endpoint does not take any arguments.

Websocket usage: {"action": "/api/v1/public/cancelheartbeat"}

Response

This endpoint returns an empty message (i.e. without result field).

Example

// Websocket:
//   {"action": "/api/v1/public/cancelheartbeat"}

{
    ...
}

test

Tests the connection to the API server, and returns its version. You can use this to make sure the API is reachable, and matches the expected version.

This request does not take any arguments.

Response

This API endpoint does not return any result: contrary to other API endpoints, there is no result field. There is, however an apiBuild field present at the root level.

HTTP usage: GET /api/v1/public/test

Websocket usage: {"action": "/api/v1/public/test"}

Example

// HTTP:
//   GET /api/v1/public/test?expired=false
// Websocket:
//   {"action": "/api/v1/public/test", 
//    "arguments": {"expired": false}}

{
    "message":"public API test",
    "apiBuild":"1.2.26",
    ...
}

ping

This API endpoint always responds with "pong". This method is primarily intended to be used as a keep alive message over websocket. When used over HTTP this API endpoint could also be used to measure network delays between your software and the API server.

This request does not take any arguments.

HTTP usage: GET /api/v1/public/ping

Websocket usage: {"action": "/api/v1/public/ping"}

Response

This API endpoint returns the current time in ms since Jan 1^st 1970.

Example

// HTTP: 
//   GET /api/v1/public/ping
// Websocket:
//   {"action": "/api/v1/public/ping"}

{
    "result": "pong",
    ...
}

getinstruments

Retrieves available trading instruments. This API endpoint can be used to see which instruments are available for trading, or which instrument have existed historically.

HTTP usage: GET /api/v1/public/getinstruments

Websocket usage: {"action": "/api/v1/public/getinstruments", "arguments": {...}}

Arguments

Response

This API endpoint returns a list of instruments in the result field. An instrument consists of the following fields:

Example

// HTTP:
//   GET /api/v1/public/getinstruments?expired=false
// Websocket:
//   {"action": "/api/v1/public/getinstruments", 
//    "arguments": {"expired": false}}

{
    "result": [
        {
            "kind":"future",
            "baseCurrency":"BTC",
            "currency":"USD",
            "minTradeSize":1,
            "instrumentName":"BTC-28SEP18",
            "isActive":true,
            "settlement":"month",
            "created":"2018-04-12 19:34:07 GMT",
            "tickSize":0.5,
            "pricePrecision":1,
            "expiration":"2018-09-28 08:00:00 GMT"
        },
        ...
    ],
    ...
}

getcurrencies

Retrieves all cryptocurrencies supported by the API. This API endpoint does not take any arguments

HTTP usage: GET /api/v1/public/getcurrencies

Websocket usage: {"action": "/api/v1/public/getcurrencies"}

Response

This API endpoint returns a list of currencies in the result field. A currency consists of the following fields:

Example

// HTTP:
//   GET /api/v1/public/getcurrencies?expired=false
// Websocket:
//   {"action": "/api/v1/public/getcurrencies"}

{
    "result": [
        {
            "currency": "BTC",
            "currencyLong": "Bitcoin",
            "minConfirmation": 2,
            "txFee": 0.0006,
            "isActive": true,
            "coinType": "BITCOIN",
            "baseAddress": null
        }
    ],
    ...
}

index

Retrieves the current index price for the BTC-USD instruments. This API endpoint does not take any arguments

HTTP usage: GET /api/v1/public/index

Websocket usage: {"action": "/api/v1/public/index", "arguments": {...}}

Response

This API endpoint returns two prices in the result field.

Example

// HTTP:
//   GET /api/v1/public/index
// Websocket:
//   {"action": "/api/v1/public/index"}

{
    "result": {
        "btc": 11628.81,
        "edp": 11628.81
    },
}

getorderbook

HTTP usage: GET /api/v1/public/getorderbook

Websocket usage: {"action": "/api/v1/public/getorderbook", "arguments": {...}}

Retrieves the order book, along with other market values for a given instrument.

Arguments

Response

The response contains the requested values in the result field.

The fields bids and asks are lists of order book price level entries, sorted from best to worst.

Example

// HTTP:
//   GET /api/v1/public/getorderbook?instrument=BTC-23FEB18
// Websocket:
//   {"action": "/api/v1/public/getorderbook", 
//    "arguments": {"instrument": "BTC-23FEB18"}}

{
    "result": {
        "state": "open",
        "settlementPrice": 11013.37,
        "instrument": "BTC-23FEB18",
        "bids": [
            {
                "quantity": 800,
                "price": 10322.56,
                "cm": 800
            },
           ...
        ],
        "asks": [
            {
                "quantity": 510,
                "price": 10334.06,
                "cm": 510
            },
            ...
        ],
        "tstamp": 1517329113791,
        "last": 10350,
        "low": 10296.11,
        "high": 10916.03,
        "mark": 10334.06,
        "uPx": 10408.16,
        "uIx": "BTC-30MAR18",
        "iR": 0,
        "markIv": 135,
        "askIv": 130.06,
        "bidIv": 109.99
    },
}

getlasttrades

Retrieve the latest trades that have occurred for a specific instrument. Trades are identified in two ways:

• the trade is (tradeId), which is unique between all instruments, but is not guaranteed to be strictly sequential.
• the trade sequence (tradeSeq), which starts at 1 for each instruments, and is strictly sequential. Under rare circumstances, it is possible for the trade sequence to skip a few numbers.

HTTP usage: GET /api/v1/public/getlasttrades

Websocket usage: {"action": "/api/v1/public/getlasttrades", "arguments": {...}}

Arguments

Response

The response contains the a list of trades in the result field. A trade consists of the following fields:

Example:

// HTTP:
//   GET /api/v1/public/getlasttrades?startId=49366&instrument=BTC-25AUG17-3900-C
// Websocket:
//   {"action": "/api/v1/public/getlasttrades", 
//    "arguments": {"startId": 49366, "instrument": "BTC-25AUG17-3900-C"}}

{
    "result": [
        {
            "tradeId": 49366,
            "instrument": "BTC-25AUG17-3900-C",
            "tradeSeq": 1,
            "timeStamp": 1503439494351,
            "quantity": 5,
            "price": 0.055,
            "direction": "buy",
            "tickDirection": 1,
            "indexPrice": 4101.46,
            "iv": 70.71
        }
        ...
    ],
    ...
}

getsummary

Retrieves the summary information such as open interest, 24h volume, etc. for a specific instrument.

HTTP usage: GET /api/v1/public/getsummary

Websocket usage: {"action": "/api/v1/public/getsummary", "arguments": {...}}

Arguments

Response

The result field contains a list of instrument data, if multiple instruments were requested, or a single object when a single instrument was requested.

Example

Retrieving a single instrument summary:

// HTTP:
//   GET /api/v1/public/getsummary?instrument=BTC-23FEB18
// Websocket:
//   {"action": "/api/v1/public/getsummary", 
//    "arguments": {"instrument": "BTC-23FEB18"}}

{
    "result": {
        "instrumentName": "BTC-23FEB18",
        "openInterest": 16525,
        "high": 10916.03,
        "low": 10000,
        "volume": 4967,
        "volumeBtc": 4.81149499,
        "last": 10000,
        "bidPrice": 10022.89,
        "askPrice": 10034.39,
        "midPrice": 10028.64,
        "markPrice": 10022.89,
        "estDelPrice": 10023.01,
        "created": "2018-01-30 18:36:34 GMT"
    },
    ...
}

Retrieving a instrument summaries for all futures:

// HTTP:
//   GET /api/v1/public/getsummary?instrument=futures
// Websocket:
//   {"action": "/api/v1/public/getsummary", 
//    "arguments": {"instrument": "futures"}}

{
    "result": {
        [
            "instrumentName": "BTC-23FEB18",
            "openInterest": 16525,
            "high": 10916.03,
            "low": 10000,
            "volume": 4967,
            "volumeBtc": 4.81149499,
            "last": 10000,
            "bidPrice": 10022.89,
            "askPrice": 10034.39,
            "midPrice": 10028.64,
            "markPrice": 10022.89,
            "estDelPrice": 10023.01,
            "created": "2018-01-30 18:36:34 GMT"
        ],
        ...
    },
    ...
}

stats

Retrieves aggregated 24h trade volumes for different instrument types. This API endpoint does not take any arguments.

HTTP usage: GET /api/v1/public/stats

Websocket usage: {"action": "/api/v1/public/stats"}

Response

The result field contains a created field, which is the GMT date for the statistics, and a field for each currency pair supported by the exchange.

Each currency pair contains the following fields:

Example

// HTTP:
//   GET /api/v1/public/stats?expired=false
// Websocket:
//   {"action": "/api/v1/public/stats"}

{
    "result": {
        "btc_usd": {
            "futuresVolume": 30.5178,
            "putsVolume": 60.2,
            "callsVolume": 2.1
        },
        "created": "2018-01-30 19:00:30 GMT"
    },
}

getannouncements

Retrieves announcements from last 30 days. This API endpoint does not take any arguments.

HTTP usage: GET /api/v1/public/getannouncements

Websocket usage: {"action": "/api/v1/public/getannouncements"}

Response

The result field contains a list of announcements. Each announcement has the following fields:

Example

// HTTP:
//   GET /api/v1/public/getannouncements
// Websocket:
//   {"action": "/api/v1/public/getannouncements"}

{
    "result": [
        {
            "title": "DERIBIT TESTNET announcement",
            "important": false,
            "id": 1516016139692,
            "date": 1516016117000,
            "body": "DERIBIT TESTNET announcement"
        }
    ],
}

getlastsettlements

Retrieves settlement, delivery and bankruptcy events that have occurred.

HTTP usage: GET /api/v1/public/getlastsettlements

Websocket usage: {"action": "/api/v1/public/getlastsettlements", "arguments": {...}}

Arguments

Response

The result field contains two fields: continuation, which is the continuation token for pagination and settlements. Settlements contain the following fields:

Example

// HTTP:
//   GET /api/v1/public/getlastsettlements?instrument=BTC-23MAR18-9500-P
// Websocket:
//   {"action": "/api/v1/public/getlastsettlements", 
//    "arguments": {"instrument": BTC-23MAR18-9500-P}}

{
    "result": {
        "settlements": [
            {
                "instrument":"BTC-23MAR18-9500-P"
                "position":26591.7
                "indexPrice":8407.01
                "markPrice":0.130009361
                "profitLoss":-1.973096726
                "type":"delivery"
                "timeStamp":1521792000104
                "sessionProfitLoss":820.137161473},
            {
                "instrument":"BTC-30MAR18"
                "position":151042
                "indexPrice":7530.81
                "markPrice":7498.3
                "profitLoss":-9.060882648999993
                "type":"settlement"
                "timeStamp":1522310400113
                "sessionProfitLoss":40791.1364678138},
            {
                "funded":0.12781214200000002
                "socialized":0.0
                "sessionBankrupcy":1.0232674799999997
                "sessionTaxRate":0.0
                "sessionTax":0.12781214200000002
                "type":"bankruptcy"
                "timeStamp":1522396800132
                "sessionProfitLoss":1923.3313302059998},
            ...
        ],
        "continuation": "xY7T6cut9u3vfTpDNun2T88wzDVfrNdKFeSDVgBGzmKdsMHgNxEwX"
    }
    ...
}

Private API

account

Retrieves user account summary. This API endpoint requires your request to be signed.

HTTP Usage: GET /api/v1/private/account

Websocket usage: {"action": "/api/v1/private/account", "arguments": {...}}

Arguments

Response

Example

// HTTP:
//   GET /api/v1/public/account?ext=true
// Websocket:
//   {"action": "/api/v1/private/account", 
//    "arguments": {"ext": true}}

{
    "result": {
        "equity": 4417.99967254,
        "maintenanceMargin": 382.7182731431261,
        "initialMargin": 497.53375508606393,
        "availableFunds": 3920.465917454,
        "balance": 5222.757514792,
        "depositAddress": "14diAAyXL5UzhPTCKC998ch2GV7DMb7yDi",
        "SUPL": 25.62979379,
        "SRPL": -7.12234779,
        "PNL": 7.6426592,
        "optionsPNL": 8.24769235,
        "optionsSUPL": 25.64732556,
        "optionsSRPL": -7.67997179,
        "optionsD": 446.5224,
        "optionsG": -0.2021,
        "optionsV": -31145.8756,
        "optionsTh": 36827.1771,
        "futuresPNL": -0.60503314,
        "futuresSUPL": -0.01753178,
        "futuresSRPL": 0.557624,
        "deltaTotal": 1254.3925,

        "nick": "User1",
        "email": "[email protected]",
        "tfa": false
    },
    ...
}

buy

Places a buy order for an instrument. This API endpoint requires your request to be signed. When used over HTTP, this API endpoint requires POST.

HTTP Usage: POST /api/v1/private/buy

Websocket usage: {"action": "/api/v1/private/buy", "arguments": {...}}

Arguments

}

• When submitting an option order with adv=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%.
• When submitting an option order with adv=usd, the field price should be the option price value in USD.
• adv=implv and adv=usd cannot be combined with post_only=true.
• max_show and post_only are only valid in combination with time_in_force=good_til_cancelled

Response

The result field contains two fields: the created order in order and a list of the resulting trades in trades.

Order consists of

When the order resulted in trades immediately (e.g. market order), there will also be a number of trades:

Example

// HTTP:
//   POST /api/v1/private/buy
//   instrument=BTC-23FEB18&type=market&quantity=10
// Websocket:
//   {"action": "/api/v1/private/buy", 
//    "arguments": {"instrument": "BTC-23FEB18",
//                  "type": "market",
//                  "quantity": 10}}

{
    "result": {
        "order": {
            "orderId": 713637304, 
            "type": "limit", 
            "instrument": "BTC-23FEB18", 
            "direction": "buy", 
            "price": 10100.0, 
            "label": "", 
            "quantity": 10, 
            "filledQuantity": 10, 
            "avgPrice": 8913.21, 
            "commission": 0.0000280482, 
            "created": 1517614581664, 
            "lastUpdate": 1517614581664, 
            "state": "filled", 
            "postOnly": true, 
            "api": true, 
            "adv": false, 
        },
        "trades": [ 
            {
                "label": "", 
                "selfTrade": false, 
                "quantity": 10, 
                "price": 8913.21, 
                "tradeSeq": 36223, 
                "matchingId": 723513284 
            },
            ...
        ]
    }
}

sell

Places a sell order for an instrument. This API endpoint requires your request to be signed. When used over HTTP, this API endpoint requires POST.

HTTP Usage: POST /api/v1/private/sell

Websocket usage: {"action": "/api/v1/private/sell", "arguments": {...}}

Arguments

}

• When submitting an option order with adv=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%.
• When submitting an option order with adv=usd, the field price should be the option price value in USD.
• adv=implv and adv=usd cannot be combined with post_only=true.
• max_show and post_only are only valid in combination with time_in_force=good_til_cancelled

Response

The result field contains two fields: the created order in order and a list of the resulting trades in trades.

Order consists of

When the order resulted in trades immediately (e.g. market order), there will also be a number of trades:

Example

// HTTP:
//   POST /api/v1/private/sell
//   instrument=BTC-23FEB18&type=market&quantity=10
// Websocket:
//   {"action": "/api/v1/private/sell", 
//    "arguments": {"instrument": "BTC-23FEB18",
//                  "type": "market",
//                  "quantity": 10}}

{
    "result": {
        "order": {
            "orderId": 713637304, 
            "type": "limit", 
            "instrument": "BTC-23FEB18", 
            "direction": "sell", 
            "price": 10100.0, 
            "label": "", 
            "quantity": 10, 
            "filledQuantity": 10, 
            "avgPrice": 8913.21, 
            "commission": 0.0000280482, 
            "created": 1517614581664, 
            "lastUpdate": 1517614581664, 
            "state": "filled", 
            "postOnly": true, 
            "api": true, 
            "adv": false, 
        },
        "trades": [ 
            {
                "label": "", 
                "selfTrade": false, 
                "quantity": 10, 
                "price": 8913.21, 
                "tradeSeq": 36223, 
                "matchingId": 723513284 
            },
            ...
        ]
    }
}

edit

Changes price and/or quantity of the own order. This API endpoint requires your request to be signed. When used over HTTP, this API endpoint requires POST.

HTTP Usage: POST /api/v1/private/edit

Websocket usage: {"action": "/api/v1/private/edit", "arguments": {...}}

Arguments

• When editing an option order with adv=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%.
• When editing an option order with adv=usd, the field price should be the option price value in USD.
• adv=implv and adv=usd cannot be combined with post_only=true.
• max_show and post_only are only valid in combination with time_in_force=good_til_cancelled
• If you have posted an advanced option order, it is necessary to re-supply the adv parameter when editing it.

Response

The result field contains two fields: the created order in order and a list of the resulting trades in trades.

Order consists of

When the edit resulted in trades immediately (e.g. crossed the bid/ask), there will also be a number of trades:

Example

// HTTP:
//   POST /api/v1/private/edit
//   orderId=713637304&quantity=1&price=10100
// Websocket:
//   {"action": "/api/v1/private/edit", 
//    "arguments": {"orderId": "713637304",
//                  "price": "10100",
//                  "quantity": 1}}

{
    "result": {
        "order": {
            "orderId": 713637304, 
            "type": "limit", 
            "instrument": "BTC-23FEB18", 
            "direction": "sell", 
            "price": 10100.0, 
            "label": "", 
            "quantity": 1, 
            "filledQuantity": 10, 
            "avgPrice": 8913.21, 
            "commission": 0.0000280482, 
            "created": 1517614581664, 
            "lastUpdate": 1517614581664, 
            "state": "filled", 
            "postOnly": true, 
            "api": true, 
            "adv": false, 
        },
        "trades": []
    }
    ...
}

cancel

Cancels an order, specified by order id. This API endpoint requires your request to be signed. When used over HTTP, this API endpoint requires POST.

HTTP Usage: POST /api/v1/private/cancel

Websocket usage: {"action": "/api/v1/private/cancel", "arguments": {...}}

Arguments

Response

The result field contains a single order field. This order consists of the following entries:

Example

// HTTP:
//   POST /api/v1/private/cancel
//   orderId=713637304
// Websocket:
//   {"action": "/api/v1/private/cancel", 
//    "arguments": {"orderId": "713637304"}}

{
    "result": {
        "order": {
            "orderId": 713637304,
            "type": "limit",
            "instrument": "BTC-23FEB18",
            "direction": "sell",
            "price": 7000,
            "label": "",
            "quantity": 1,
            "filledQuantity": 0,
            "avgPrice": 0,
            "commission": 0,
            "created": 1517614581664,
            "lastUpdate": 1517614581664,
            "state": "cancelled",
            "postOnly": true,
            "api": true,
            "max_show": 1,
            "adv": false,
        }
    }
}

cancelall

HTTP Usage: POST /api/v1/private/cancelall

Websocket usage: {"action": "/api/v1/private/cancelall", "arguments": {...}}

Cancels all orders, optionally filtered by instrument or instrument type. This API endpoint requires your request to be signed. When used over HTTP, this API endpoint requires POST.

Arguments

Response

The response contains just the common response fields. There is no result field.

Example

// HTTP:
//   POST /api/v1/private/cancelall
//   type=options
// Websocket:
//   {"action": "/api/v1/private/cancelall", 
//    "arguments": {"type": "options"}}

{
    ...
}

getopenorders

Retrieves open orders. This API endpoint requires your request to be signed.

HTTP Usage: GET /api/v1/private/getopenorders

Websocket usage: {"action": "/api/v1/private/getopenorders", "arguments": {...}}

Arguments

Response

The result field contains a a list of orders. These orders consists of the following fields:

Example

// HTTP:
//   GET /api/v1/private/getopenorders?orderId=713637304
// Websocket:
//   {"action": "/api/v1/private/getopenorders", 
//    "arguments": {"orderId": 713637304}}

{
    "result": [ 
        {
            "orderId": 713637304, 
            "type": "limit", 
            "instrument": "BTC-23FEB18", 
            "direction": "sell", 
            "price": 10000, 
            "label": "1", 
            "quantity": 1, 
            "filledQuantity": 0, 
            "avgPrice": 0, 
            "commission": 0, 
            "created": 1517614581664, 
            "lastUpdate": 1517614581664, 
            "state": "open", 
            "postOnly": true, 
            "api": true, 
            "max_show": 1, 
            "adv": false, 
        }
    ]
}

positions

Retrieves current positions. This API endpoint requires your request to be signed. This API endpoint does not take any arguments

HTTP Usage: GET /api/v1/private/positions

Websocket usage: {"action": "/api/v1/private/positions"}

Response

Example

// HTTP:
//   GET /api/v1/private/positions
// Websocket:
//   {"action": "/api/v1/private/positions"}

{
    "result": [ 
        {  
            "instrument": "BTC-30MAR18",
            "kind": "future",
            "size": 5893,
            "averagePrice": 9693.502194671,
            "direction": "buy",
            "sizeBtc": 7.14775214,
            "floatingPl": -0.703874042,
            "realizedPl": 0, 
            "estLiqPrice": 99999.99,
            "markPrice": 8244.55,
            "indexPrice": 8242.12,
            "maintenanceMargin": 0.214432564,
            "initialMargin": 0.357387607,
            "settlementPrice": 9145.26,
            "delta": 7.14775214,
            "openOrderMargin": 0,
            "profitLoss": -1.068422015
        }
    ],
}

orderhistory

Retrieves history of orders that have been partially or fully filled. This API endpoint requires your request to be signed.

HTTP Usage: GET /api/v1/private/orderhistory

Websocket usage: {"action": "/api/v1/private/orderhistory", "arguments": {...}}

Arguments

Response

The result field contains a a list of orders. These orders consists of the following fields:

Example

// HTTP:
//   GET /api/v1/private/orderhistory?count=10
// Websocket:
//   {"action": "/api/v1/private/orderhistory", 
//    "arguments": {"count": 10}}

{
    "result": [
        {
            "orderId": 723289117,
            "type": "limit",
            "instrument": "BTC-23FEB18-10500-P",
            "direction": "sell",
            "price": 0.2633,
            "quantity": 5,
            "filledQuantity": 5,
            "avgPrice": 0.26,
            "state": "filled",
            "created": 1517765999188,
            "tstamp": 1517766824804,
            "commission": 0,
            "modified": 1517766824810,
            "label": "", 
            "postOnly": false,
        }
    ],
}

orderstate

Retrieve order details state by order id. This API endpoint requires your request to be signed.

HTTP Usage: GET /api/v1/private/orderstate

Websocket usage: {"action": "/api/v1/private/orderstate", "arguments": {...}}

Arguments

Response

The result field contains single order. An order consists of the following fields:

Example

// HTTP:
//   GET /api/v1/private/orderstate?orderId=723289117
// Websocket:
//   {"action": "/api/v1/private/orderstate", 
//    "arguments": {"orderId": 723289117}}

{
    "result": {
        "orderId": 723289117,
        "type": "limit",
        "instrument": "BTC-23FEB18-10500-P",
        "direction": "sell",
        "price": 0.2633,
        "quantity": 5,
        "filledQuantity": 5,
        "avgPrice": 0.26,
        "state": "filled",
        "created": 1517765999188,
        "tstamp": 1517766824804,
        "commission": 0,
        "modified": 1517766824810,
        "label": "", 
        "postOnly": false,
    },
}

tradehistory

Retrieve the trade history of the account. This API endpoint requires your request to be signed.

HTTP Usage: GET /api/v1/private/tradehistory

Websocket usage: {"action": "/api/v1/private/tradehistory", "arguments": {...}}

Arguments

Response

The response contains the a list of trades in the result field. A trade consists of the following fields:

Example

// HTTP:
//    GET /api/v1/private/tradehistory?instrument=all
// Websocket:
//   {"action": "/api/v1/private/tradehistory", 
//    "arguments": {"instrument": "all"}}

{
    "success": true,
    "testnet": false,
    "message": "",
    "usIn": 1528814000104342,
    "usOut": 1528814000104611,
    "result": [
        {
            "tradeId": 7186202,
            "instrument": "BTC-28SEP18",
            "timeStamp": 1528631913389,
            "tradeSeq": 252216,
            "quantity": 30,
            "price": 7093,
            "side": "buy",
            "orderId": 4479673241,
            "matchingId": 4853295396,
            "liquidity": "M",
            "fee": -0.000008459,
            "feeCurrency": "BTC",
            "tickDirection": 2,
            "indexPrice": 7069.14,
            "selfTrade": false
        },
        ...
    ]
}

newannouncements

Retrieves announcements that have not been marked read by the current user. This API endpoint requires your request to be signed. This API endpoint does not take any arguments.

HTTP usage: GET /api/v1/private/newannouncements

Websocket usage: {"action": "/api/v1/private/newannouncements"}

Response

The result field contains a list of announcements. Each announcement has the following fields:

Example

// HTTP:
//   GET /api/v1/public/newannouncements
// Websocket:
//   {"action": "/api/v1/public/newannouncements"}

{
    "result": [
        {
            "title": "DERIBIT TESTNET announcement",
            "important": false,
            "id": 1516016139692,
            "date": 1516016117000,
            "body": "DERIBIT TESTNET announcement"
        }
    ],
}

logout

Logs out the websocket connection. The server will respond by closing the connection. This API endpoint requires your request to be signed. This API endpoint does not take any arguments.

Websocket usage: {"action": "/api/v1/private/logout"}

Response

The server will respond by closing the connection

Example

// Websocket:
//   {"action": "/api/v1/private/logout"}

cancelondisconnect

Enables or disables "COD" (cancel on disconnect) for the current connection. This API endpoint requires your request to be signed. This does not change the default account setting. This API endpoint cannot be used over HTTP

Websocket usage: {"action": "/api/v1/private/cancelondisconnect"}

Arguments

Response

This API endpoint will return an empty response (i.e. without an result field)

Example

// Websocket:
//   {"action": "/api/v1/public/cancelondisconnect", 
//    "arguments": { "state": "enabled"}}

{
    ...
}

datatable

This is a private API endpoint intended for the user interface. This API is subject to change, and should not be used outside the Deribit interface.

getemaillang

Retrieves the language to be used for emails. This API endpoint requires your request to be signed. This API does not take any parameters.

HTTP usage: GET /api/v1/private/getemaillang

Websocket usage: {"action": "/api/v1/private/getemaillang"}

Response

The result field will be a string with the abbreviated language name (e.g. "en", "ko", "zh")

Example

// HTTP:
//   GET /api/v1/private/getemaillang
// Websocket:
//   {"action": "/api/v1/private/getemaillang"}

{
    "result": "en",
}

setemaillang

Changes the language to be used for emails. This API endpoint requires your request to be signed. When used over HTTP, this API endpoint requires POST.

HTTP usage: GET /api/v1/private/setemaillang

Websocket usage: {"action": "/api/v1/private/setemaillang"}

Arguments

Response

This API endpoint will return an empty response (i.e. without an result field)

Example

// HTTP:
//   POST /api/v1/private/setemaillang
//   lang=en
// Websocket:
//   {"action": "/api/v1/private/setemaillang", 
//    "arguments": {"lang": "en"}}

{
    "result": null,
}

setannouncementasread

Marks an announcement as read, so it will not be shown in newannouncements. This API endpoint requires your request to be signed. When used over HTTP, this API endpoint requires POST.

HTTP usage: GET /api/v1/private/setannouncementasread

Websocket usage: {"action": "/api/v1/private/setannouncementasread

Arguments

Example

// HTTP:
//   POST /api/v1/private/setannouncementasread
//   announcementid=199238817
// Websocket:
//   {"action": "/api/v1/private/setannouncementasread", 
//    "arguments": {"announcementid": "199238817"}}
{
    "result": "ok",
}

settlementhistory

Retrieves settlement, delivery and bankruptcy events that have affected your account. This API endpoint requires your request to be signed.

HTTP usage: GET /api/v1/private/settlementhistory

Websocket usage: {"action": "/api/v1/private/settlementhistory", "arguments": {...}}

Arguments

Response

The result field contains two fields: continuation, which is the continuation token for pagination and settlements. Settlements contain the following fields:

Example

// HTTP:
//   GET /api/v1/private/settlementhistory?instrument=BTC-23MAR18-9500-P
// Websocket:
//   {"action": "/api/v1/private/settlementhistory", 
//    "arguments": {"instrument": BTC-23MAR18-9500-P}}

{
    "result": {
        "settlements": [
            {
                "instrument":"BTC-23MAR18-9500-P"
                "position":26591.7
                "indexPrice":8407.01
                "markPrice":0.130009361
                "profitLoss":-1.973096726
                "type":"delivery"
                "timeStamp":1521792000104
                "sessionProfitLoss":820.137161473},
            {
                "instrument":"BTC-30MAR18"
                "position":151042
                "indexPrice":7530.81
                "markPrice":7498.3
                "profitLoss":-9.060882648999993
                "type":"settlement"
                "timeStamp":1522310400113
                "sessionProfitLoss":40791.1364678138},
            {
                "funded":0.12781214200000002
                "socialized":0.0
                "sessionBankrupcy":1.0232674799999997
                "sessionTaxRate":0.0
                "sessionTax":0.12781214200000002
                "type":"bankruptcy"
                "timeStamp":1522396800132
                "sessionProfitLoss":1923.3313302059998},
            ...
        ],
        "continuation": "xY7T6cut9u3vfTpDNun2T88wzDVfrNdKFeSDVgBGzmKdsMHgNxEwX"
    }
    ...
}

subscribe

Subscribes to a notification channel. See Websocket notifications for details. This API endpoint cannot be used over HTTP.

Calling subscribe will replace all previous subscriptions for this connection.

Websocket usage: {"action": "/api/v1/private/subscribe", "arguments": {...}}

Arguments

The following events can be subscribed to:

• order_book, notifies of order book changes
• trade, trade notifications
• my_trade, trade notifications, filtered for user trades.
• user_order, notifies of opened, changed or filled user orders.
• index, notifies of index value at frequent intervals.
• portfolio, notifies of portfolio changes.
• announcement, notifies of index value at frequent intervals.
• delivery, notifies of deliveries.

Response

This API endpoint will return an empty response (i.e. without an result field), and start sending notification of events as they occur.

Example

// Websocket:
//   {"action": "/api/v1/private/subscribe",
//    "arguments": {"event": ["order_book"],
//                  "instrument": ["BTC-28SEP18-35000-P"]}}

{
    ...
}

unsubscribe

Unsubscribes from a notification channel. See Websocket notifications for details. This API endpoint cannot be used over HTTP.

Websocket usage: {"action": "/api/v1/private/unsubscribe", "arguments": {...}}

Arguments

Response

This API endpoint will return an empty response (i.e. without an result field)

Example

// Websocket:
//   {"action": "/api/v1/private/unsubscribe",
//    "arguments": {"event": ["order_book"],
//                  "instrument": ["BTC-28SEP18-35000-P"]}}

{
    ...
}