NAV
bash

Introduction

Welcome to the DVC OTC API. You can use our API to access DVC OTC API endpoints, that expose data such as trades, prices, and user information, depending on your scope.

Environment URLs

The DV OTC API is available in both Production as well as Sandbox Mode. Please find the corresponding URLs below

Production

https://trade.dvchain.co/api/v4

Sandbox

https://sandbox.trade.dvchain.co/api/v4

Authentication

Get the jwt access token following the docs at https://github.com/dv-chain/dv-chain/wiki/Rest-API-Authentication

Prices

Get Current Asset Prices

curl "https://sandbox.trade.dvchain.co/api/v4/prices"
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
    "BTC": {
        "levels": [
            {
                "sellPrice": 6181.4,
                "buyPrice": 6218.61,
                "maxQuantity": 1
            },
            {
                "sellPrice": 6171.43,
                "buyPrice": 6228.63,
                "maxQuantity": 5
            },
            {
                "sellPrice": 6161.46,
                "buyPrice": 6238.66,
                "maxQuantity": 10
            }
        ],
        "expiresAt": 1539626145342
    },
    "ETH": {
        "levels": [
            {
                "sellPrice": 198.4,
                "buyPrice": 200.6,
                "maxQuantity": 10
            },
            {
                "sellPrice": 197.41,
                "buyPrice": 201.6,
                "maxQuantity": 20
            },
            {
                "sellPrice": 196.41,
                "buyPrice": 202.61,
                "maxQuantity": 30
            }
        ],
        "expiresAt": 1539626145342
    }
}

This endpoint retrieves all available products and their prices.

The levels array includes the asset price by quantity.

For example, an order of up to 1 BTC would be priced at $6,218.61 per Bitcoin for a buy order, and $6,181.40 per Bitcoin for a sell order. An order of up to 5 BTC would be priced at $6,228.63 per Bitcoin for a buy order, and $6,171.43 per Bitcoin for a sell order.

The given price will expire after the “expiresAt” time has passed.

HTTP Request

GET https://sandbox.trade.dvchain.co/api/v4/prices

Get Coin Pair Pricing

curl "https://sandbox.trade.dvchain.co/api/v4/prices/BTC/BCH"
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
    "BTC": {
        "levels": [
            {
                "sellPrice": 10.59319286871961,
                "buyPrice": 11.420593368237347,
                "maxQuantity": 1
            },
            {
                "sellPrice": 10.588330632090761,
                "buyPrice": 11.425828970331589,
                "maxQuantity": 3
            },
            {
                "sellPrice": 10.581847649918963,
                "buyPrice": 11.432809773123909,
                "maxQuantity": 5
            }
        ],
        "expiresAt": 1545161432916
    }
}

This endpoint retrieves the conversion pricing for coin to coin transactions.

The first symbol in the URL is the asset that will be purchased, and the second symbol is the asset that will be sold.

HTTP Request

GET https://sandbox.trade.dvchain.co/api/v4/prices/BTC/BCH

Token Trade

Executing a trade with the Token Trade workflow consists of:

  1. Requesting an assets price for a given quantity over the api/v5/RFQ endpoint
  2. Submitting the tradeKey returned from the previous call to the api/v5/rfq/execute endpoint to execute your trade.

RFQ

curl "https://sandbox.trade.dvchain.co/api/v5/RFQ?side=Buy&qty=1&asset=BTC&counterAsset=USD"
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
    "asset":"BTC",
    "counterAsset": "USD",
    "price":10541.12,
    "qty":1,
    "side":"Buy",
    "expiresIn":5000,
    "serverTime":1568311644602,
    "expiresAt":1568311649602,
    "tradeKey":"5cd07738b861c31e3bd61467BTC1Buy1568311644602"
}

This endpoint retrieves the buy/sell price for an asset at the requested quantity.

This endpoint retrieves the buy/sell price for an asset at the requested quantity.
If you use the total query parameter instead of qty, the endpoint retrieves
the buy/sell quantity at that requested price

There are two fields returned related to key expiry. The expiresIn field is the time in ms until
the tradeKey expires, beginning from when the response was issued from the server. The expiresAt
field is the server time when the time will expire in Unix millisecond time, and the serverTime is
the time the response was issued, which is Unix time in milliseconds.

HTTP Request

GET https://sandbox.trade.dvchain.co/api/v5/RFQ?side=Buy&qty=1&asset=BTC&counterAsset=USD

Query Params

Parameter Description
side Buy or Sell
qty The quantity you would like to purchase.
total The amount you would like to spend in counter asset to purchase.
asset The asset you would like to purchase.
counterAsset The asset you would like to spend.

Execute Trade

curl "https://sandbox.trade.dvchain.co/api/v5/RFQ/execute" \
  -X POST \
  -d '{ "key" : "5cd07738b861c31e3bd61467BTC1Buy1568311644602" }' \
  -H "Content-Type: application/json" \
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
    "_id":"5d7a8e90019f4113c4df8e41",
    "createdAt":"2019-09-12T18:29:36.991Z",
    "price":10541.65,
    "quantity":1,
    "side":"Buy",
    "user": { "_id": "5cd07738b861c31e3bd61467",
              "firstName":"test",
              "lastName":"acct" },
    "asset":"BTC",
    "counterAsset":"USD",
    "status":"Complete"
}

This endpoint executes a trade for the token given from the api/v5/RFQ endpoint

HTTP Request

POST https://sandbox.trade.dvchain.co/api/v5/RFQ/execute

Request Body

Parameter Description
key tradeKey from api/v5/RFQ response

RFQ

Get Current Asset Price By Size

curl "https://sandbox.trade.dvchain.co/api/v4/RFQ?side=Buy&qty=1&asset=BTC&counterAsset=USD"
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
   "asset": "ETH",
   "counterAsset": "USD",
   "price": 201.6,
   "qty": 19,
   "side": "Buy",
   "expiresAt": 1540246595317
}

This endpoint retrieves the buy/sell price for an asset at the requested quantity.
If you use the total query parameter instead of qty, the endpoint retrieves
the buy/sell quantity at that requested price

The given price will expire after the “expiresAt” time has passed.

HTTP Request

GET https://sandbox.trade.dvchain.co/api/v4/RFQ?side=Buy&qty=1&asset=BTC&counterAsset=USD

Query Params

Parameter Description
side Buy or Sell
qty The quantity you would like to purchase.
total The amount you would like to spend in USD to purchase.
asset The asset you would like to purchase.
counterAsset The asset you would like to spend.

Trade

Execute a Trade

curl "https://sandbox.trade.dvchain.co/api/v4/trade" \
  -X POST \
  -d '{"side": "Buy","qty": 0.1,"price": 527.51,"asset": "BCH", "counterAsset": "USD"}' \
  -H "Content-Type: application/json" \
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
    "_id": "5bbe696c5f7cec5b98ca5e9a",
    "createdAt": "2018-10-10T21:04:44.361Z",
    "price": 527.51,
    "quantity": 0.1,
    "side": "Buy",
    "user": {
        "_id": "5ab545a4b933aa1f78e25f34",
        "firstName": "Satoshi",
        "lastName": "Nakamoto"
    },
    "asset": "BTC",
    "counterAsset": "USD",
    "status": "Complete"
}

This endpoint executes a trade at the current asset price for the given quantity.

HTTP Request

POST https://sandbox.trade.dvchain.co/api/v4/trades

Request Body

Parameter Default Description
orderType Market Market or Limit
side none Buy or Sell
qty none The quantity you would like to purchase.
asset none The asset you would like to purchase.
price none (Required for a market order) The current price of the asset returned from the /prices or /rfq endpoint.
limitPrice none (Required for a limit order) The limit price that you would like to pay.
counterAsset USD (Optional) The counter asset that you would like to trade against.

Limits

Get Current Positions

curl "https://sandbox.trade.dvchain.co/api/v4/balances"
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
    "assets": [
        {
            "asset": "XMR",
            "maxSell": 5000,
            "maxBuy": 5000,
            "position": 2
        },
        {
            "asset": "BTC",
            "maxSell": 250,
            "maxBuy": 250,
            "position": 2
        },
        {
            "asset": "USD",
            "maxSell": 2575000,
            "maxBuy": 2575000,
            "position": -17044.82
        }
    ],
    "usdBalance": -17044.82
}

This endpoint retrieves the net positions.

Trades

Get All Trades and Orders

curl "https://sandbox.trade.dvchain.co/api/v4/trades"
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
    "data": [
        {
            "_id": "5bbd1c6709ac22627841ad32",
            "createdAt": "2018-10-09T21:23:51.757Z",
            "price": 513.3,
            "quantity": 0.1,
            "side": "Buy",
            "tradeKey" : "1XRPUSD1Buy1595607528354",
            "clientTag" : "90c2f1ee-fe3b-497f-9b9b-8ed2595a1004",
            "user": {
                "_id": "5ab545a4b933aa1f78e25f34",
                "firstName": "Satoshi",
                "lastName": "Nakamoto"
            },
            "asset": "BCH",
            "counterAsset": "USD",
            "status": "Complete"
        }
    ],
    "total": 1,
    "pageCount": 1
}

This endpoint retrieves all trades and orders

HTTP Request

GET https://sandbox.trade.dvchain.co/api/v4/trades

Query Parameters

Parameter Default Description
before none If set, will only return trades before this date/time.
after none If set, will only return trades after this date/time.
page none If set, it will return the given page number of trades.
limit none If set, it will limit the number of trades returned per page.
status none If set, it will return only the trades corresponding to the status. Allowed values are Open, Cancelled, Complete

Query trades by Id, Trade key or Client tag

curl "https://sandbox.trade.dvchain.co/api/v4/trade?ids=90c2f1ee-fe3b-497f-9b9b-8ed2595a1004,90c2f1ee-fe3b-497f-9b9b-8ed2595a1004&tradeKeys=1XRPUSD1Buy1595607528354,1XRPUSD1Buy1595607528354&clientTags=90c2f1ee-fe3b-497f-9b9b-8ed2595a1004"
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this

{
    "data": [
        {
            "_id": "90c2f1ee-fe3b-497f-9b9b-8ed2595a1004",
            "createdAt": "2018-10-09T21:23:51.757Z",
            "price": 513.3,
            "quantity": 0.1,
            "side": "Buy",
            "tradeKey" : "1XRPUSD1Buy1595607528354",
            "clientTag" : "90c2f1ee-fe3b-497f-9b9b-8ed2595a1004",
            "user": {
                "_id": "5ab545a4b933aa1f78e25f34",
                "firstName": "Satoshi",
                "lastName": "Nakamoto"
            },
            "asset": "BCH",
            "counterAsset": "USD",
            "status": "Complete"
        }
    ]
}

This endpoint retrieves all trades and orders with tradeKey, id, client tag provided

HTTP Request

GET https://sandbox.trade.dvchain.co/api/v4/trade?ids=90c2f1ee-fe3b-497f-9b9b-8ed2595a1004,90c2f1ee-fe3b-497f-9b9b-8ed2595a1004&tradeKeys=1XRPUSD1Buy1595607528354,1XRPUSD1Buy1595607528354

Query Parameters

Parameter Default Description
ids none Comma seperated order ids.
tradeKeys none Comma seperated tradeKeys.
clientTags none Comma seperated client tag provided during order creation.

Cancel a Limit Order

curl "https://sandbox.trade.dvchain.co/api/v4/trades/:id" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

The above command returns JSON structured like this:

{
    "message": "Trade successfully cancelled."
}

This endpoint cancels an open limit order.

HTTP Request

DELETE https://sandbox.trade.dvchain.co/api/v4/trades/:id

Errors

The API uses the following error codes:

Error Code Meaning
400 Bad Request – There is something wrong with the request
401 Unauthorized – Your API key is wrong
403 Forbidden – The endpoint requested is hidden for administrators only
404 Not Found – The specified endpoint could not be found
406 Not Acceptable – You requested a format that isn’t json
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarially offline for maintanance. Please try again later.

Deprecated Authentication

Deprecated Follow API V5

To retrieve your JWT, use this code:

curl "https://sandbox.trade.dvchain.co/api/v4/auth"
  -H "Authorization: Basic ZGVtbzpwQDU1dzByZA=="

This API uses JSON Web Tokens (JWTs) to allow access to the API. You can retrive a new token using your DVC OTC credentials through BASIC authentication.
You can request a read only JWT that will only allow actions that will not modify, create, or delete objects.
To retrieve a read only token, include scope=readOnly in your query params. Your request URL will look like:

https://sandbox.trade.dvchain.co/api/v4/auth?scope=readOnly

The API expects for your JWT to be included in all API requests to the server in a header that looks like the following:

Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

BlackListing Token

This API allows you to blacklist your generated token.

To blacklist send a post request with your authorization and the token to be blacklisted in a json body with key token.

https://sandbox.trade.dvchain.co/api/v4/token/deactivate

To blacklist your JWT, use this code:

curl "https://sandbox.trade.dvchain.co/api/v4/token/deactivate" \
  -X POST \
  -d '{ "token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }' \
  -H "Content-Type: application/json" \
  -H "Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
bash