Dolomite Exchange API API Reference
The API for Dolomite - A non-custodial cryptocurrency exchange.
API Endpoint
https://exchange-api.dolomite.io/Version: beta
Websockets
Initialize Connection
Establishes the initial websocket connection, to be able to send and receive websocket requests.
The websocket connection was successfully established. No data is sent down.
All Subscriptions
Gets all of the subscriptions to which websocket instance is subscribed.
The path at which the corresponding action will be performed for upstream requests. For downstream messages this corresponds to a resource that changed in real-time.
The peration to perform or that was performed.
Request Example
{
"route": "string",
"action": "string"
}
All of the subscriptions to which websocket instance is subscribed.
The peration to perform or that was performed.
The path at which the corresponding action will be performed for upstream requests. For downstream messages this corresponds to a resource that changed in real-time.
Response Example (200 OK)
[
{
"action": "string",
"route": "string"
}
]
Watch Wallet
This websocket route is a convenience method to watch all websocket routes that are attributable to watching an address.
The path at which the corresponding action will be performed for upstream requests. For downstream messages this corresponds to a resource that changed in real-time.
The peration to perform or that was performed.
A container object that wraps criteria for websocket upstream requests.
A crypto currency address.
Request Example
{
"route": "string",
"action": "string",
"data": {
"address": "0x0000000000000000000000000000000000000000"
}
}
All of the routes that are attributable wallet addresses.
Response Example (200 OK)
"string"
Unhandled Error
This downward event is fired whenever an error occurs that cannot be tied down to a specific route. This is really important when critical errors occur and the system is unaware of how to notify subscribers of a particular address or market.
An error object, which contains the information surrounding what occurred.
The cryptocurrency wallet address tied to this operation.
The error that occurred while you had a subscription to a specific web socket topic
(no description)
(no description)
(no description)
(no description)
(no description)
(no description)
Response Example (200 OK)
{
"wallet_address": "string",
"error": {
"message": "string",
"request_id": "integer (int64)",
"code": "string",
"category": "string",
"description": "string",
"invalid_fields": [
"string"
]
}
}
Exchange Information
Current Gas Price
Gets statistics about the current gas prices being paid on the Ethereum network (shown in Wei). The numbers provided are calculated using rolling averages.
The most updated GasPriceEstimate object.
This is a gas price that is intended to be both cheap and successful. It may take a bit longer to get a confirmation with this price (e.g. 5minutes), but it is safe to use and should be confirmed propmpty. This price is determined by the lowest price where at least 5% of the network hash power will accept it. It requires that at least 50 transactions have been mined in the last 24 hours at this price. Furthermore, we monitor the network in real time and will update this price if a transaction at or above does not confirm within 50 blocks.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the price accepted by top miners who account for at leat 50% of the blocks mined- safe and prompt. Usually reflects the wallet defaults.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the 75th to 90th percentile of all gas prices accepted by the top miners over the past 10,000 blocks. This is re-balanced every 100 blocks to properly account for spikes.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the lowest gas price that is accepted by all top miners (estimated over the last two days). Therefore, transactions with this gas price should be accepted by all the top pools. Paying more than this price is unlikely to increase transaction confirmation time under normal circumstances.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The current gas price used to settle transactions.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The unit of time that it will take for the slow gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the average gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the fast gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the fastest gas price to be confirmed on the Ethereum blockchain.
Response Example (200 OK)
{
"global_objects": {},
"data": {
"slow": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"average": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"fast": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"fastest": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"current": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"slow_wait_time": "integer (int32)",
"average_wait_time": "integer (int32)",
"fast_wait_time": "integer (int32)",
"fastest_wait_time": "integer (int32)"
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Exchange Information
Gets general purpose information about Dolomite's Exchange.
An optional cryptocurrency wallet address. If supplied, the fee percentages sent in the response will reflect the fees that this wallet pays for their trades.
The general purpose information regarding Dolomite's Exchange, like contracts used, min trade amount, fees, etc.
The contract address that the Loopring Protocol uses for spot trade settlement. You can check this for audit purposes to see the trades that Dolomite is settling, trade volume, which wallets are trading, and more!
The contract address that the Loopring Protocol uses for trade settlement for margin trades. The order_recipient field for created orders must always specify this address for settlement. You can check this for audit purposes to see the trades that Dolomite is settling, trade volume, which wallets are trading, and more!
The contract address that the Loopring Protocol uses to transfer tokens out of your wallet when a trade is settled. Note, the transfer of funds can only occur when you have a non-zero allowance with this address and a valid order that can be settled. So it is essential that your wallet's allowance is set against this address for a large amount in order to enable future trades to execute.
The wallet address that is used to collect the fees from the trade. This should always be the wallet address supplied in the Exchange Information route.
The minimum size an order can be if it's a maker trade, in USD.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The minimum size an order can be if it's a taker trade, in USD.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The percentage fee of the trade's value that is charged (or paid) to market
makers. A value of 0.005 indicates a fee of 0.5%. To be a market
maker, you must place an order on the books that
does not effectively take a counter-party's order off the books. To do so, ensure you're placing the trade just above or below market price, so when the market moves in either direction, someone else's order has to be the order against which your order is matched.
The percentage fee of the trade's value that is charged to market
takers. A value of 0.005 indicates a fee of 0.5%. For more information on market
making vs market
taking see the maker_fee_percentage field.
The maximum number of matches an order can have, if it's a taker.
A map containing the different burn rates, which the Loopring Protocol takes out as a "tax" for using its protocol. The number in the map represents the percentage amount that the Protocol takes out for its cut. Meaning, the protocol fee can be calculated as expected_fee * burn_rate_unpadded_amount. This multiplier is also taken out of MAKER trades, such that if one expects the rebate to be 1.00, it would instead be 1.00 * (1 - burn_rate_unpadded_amount).
key ] {
The broker that's used to facilitate trades between the Loopring Protocol and a user's smart wallet.
The contract address of the Dolomite Direct registry, which is used to create and upgrade a user's smart wallet.
Time zone of the server.
A list of email domains that Dolomite does not support, because emails sent to those domains may be suppressed, sent directly to spam, etc.
A map containing the fee amounts to be added onto spot trading fees when executing a spot trade. See base_spot_trading_fee_amounts to see how this fee is added to it.
key ] {
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
A map containing the fee amounts to be added onto the spot trading fees when executing a margin trade. See base_spot_trading_fee_amounts to see how this fee is added to it.
key ] {
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
A map containing the fee amounts for deploying the user's smart wallet. The fees specified in this mapping should be set directly in the deployment request for the specified fee ticker.
key ] {
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
A map containing the base fee amounts for executing transfers from Dolomite's smart wallet. This is the amount of fees that should be used when executing a transfer request.
key ] {
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
Current timestamp of the server in milliseconds since the Unix epoch.
A map containing the base fee amounts for spot trading, which should be used for the "base multiplier" for any given order's fee token. When submitting an order and calculating the taker fees, you should multiply this number by the max number of taker matches it'll have. If you are unsure of how many matches it will have, you should use max_number_of_taker_matches_per_order. If the taker order needs be matched with
more trades than are specified with this base fee amount, the trade will be rejected. The order's commission is separate from these base fees. Any trading premiums (like margin or spot) should be added to this number's calculation.
key ] {
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
Response Example (200 OK)
{
"global_objects": {},
"data": {
"spot_trade_settlement_contract_address": "string",
"margin_trade_settlement_contract_address": "string",
"loopring_delegate_address": "string",
"fee_collecting_wallet_address": "string",
"min_usd_maker_trade_amount": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"min_usd_taker_trade_amount": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"maker_fee_percentage": "number (double)",
"taker_fee_percentage": "number (double)",
"max_number_of_taker_matches_per_order": "integer (int32)",
"burn_rate_unpadded_amounts": {
"LRC": "number"
},
"smart_wallet_broker": "0x0000000000000000000000000000000000000000",
"deposit_contract_registry_address": "0x0000000000000000000000000000000000000000",
"time_zone": "string",
"black_listed_email_domains": [
"string"
],
"spot_trading_fee_premium_amounts": {
"LRC": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"margin_trading_fee_premium_amounts": {
"LRC": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"create_deposit_contract_fee_amounts": {
"LRC": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"smart_wallet_transfer_fee_amounts": {
"LRC": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"server_time": 1557723502000,
"base_spot_trading_fee_amounts": {
"LRC": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
}
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Subscribe to Estimate Gas Price
Send a message up to watch for realtime updates of the most updated gas prices, based on network usage.
The peration to perform or that was performed.
subscribe unsubscribe The path at which the corresponding action will be performed for upstream requests. For downstream messages this corresponds to a resource that changed in real-time.
Request Example
{
"action": "subscribe",
"route": "string"
}
The most updated GasPriceEstimate object.
This is a gas price that is intended to be both cheap and successful. It may take a bit longer to get a confirmation with this price (e.g. 5minutes), but it is safe to use and should be confirmed propmpty. This price is determined by the lowest price where at least 5% of the network hash power will accept it. It requires that at least 50 transactions have been mined in the last 24 hours at this price. Furthermore, we monitor the network in real time and will update this price if a transaction at or above does not confirm within 50 blocks.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the price accepted by top miners who account for at leat 50% of the blocks mined- safe and prompt. Usually reflects the wallet defaults.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the 75th to 90th percentile of all gas prices accepted by the top miners over the past 10,000 blocks. This is re-balanced every 100 blocks to properly account for spikes.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the lowest gas price that is accepted by all top miners (estimated over the last two days). Therefore, transactions with this gas price should be accepted by all the top pools. Paying more than this price is unlikely to increase transaction confirmation time under normal circumstances.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The current gas price used to settle transactions.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The unit of time that it will take for the slow gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the average gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the fast gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the fastest gas price to be confirmed on the Ethereum blockchain.
Response Example (200 OK)
{
"slow": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"average": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"fast": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"fastest": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"current": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"slow_wait_time": "integer (int32)",
"average_wait_time": "integer (int32)",
"fast_wait_time": "integer (int32)",
"fastest_wait_time": "integer (int32)"
}
Receive Estimate Gas Price
The websocket sends messages down to the client periodically as gas price and consumption of the network changes.
The most updated GasPriceEstimate object.
This is a gas price that is intended to be both cheap and successful. It may take a bit longer to get a confirmation with this price (e.g. 5minutes), but it is safe to use and should be confirmed propmpty. This price is determined by the lowest price where at least 5% of the network hash power will accept it. It requires that at least 50 transactions have been mined in the last 24 hours at this price. Furthermore, we monitor the network in real time and will update this price if a transaction at or above does not confirm within 50 blocks.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the price accepted by top miners who account for at leat 50% of the blocks mined- safe and prompt. Usually reflects the wallet defaults.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the 75th to 90th percentile of all gas prices accepted by the top miners over the past 10,000 blocks. This is re-balanced every 100 blocks to properly account for spikes.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
This is the lowest gas price that is accepted by all top miners (estimated over the last two days). Therefore, transactions with this gas price should be accepted by all the top pools. Paying more than this price is unlikely to increase transaction confirmation time under normal circumstances.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The current gas price used to settle transactions.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
The different possible numerical representations of Ether.
The currency's name.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The unit of time that it will take for the slow gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the average gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the fast gas price to be confirmed on the Ethereum blockchain.
The unit of time that it will take for the fastest gas price to be confirmed on the Ethereum blockchain.
Response Example (200 OK)
{
"slow": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"average": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"fast": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"fastest": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"current": {
"amount": "string",
"unit": {
"name": "string",
"precision": 18
},
"precision": 18
},
"slow_wait_time": "integer (int32)",
"average_wait_time": "integer (int32)",
"fast_wait_time": "integer (int32)",
"fastest_wait_time": "integer (int32)"
}
Compliance
Is Unsupported Region
Returns a boolean, indicating whether or not the IP Address that sent the request is in a supported region.
The IP Address is valid and a proper geo-fence could be constructed. A return value of true indicates the region is
not supported, and all order submission requests from this IP address will fail. A value of false indicates the region is supported and all order submission requests will pass through order validation.
The IP Address could not be pinpointed to any specific region.
Response Example (200 OK)
{
"global_objects": {},
"data": "boolean",
"paging_metadata": null,
"cursor": null,
"error": null
}
Geolocation by IP Address
Estimates the location using the provided IP address of the connection established to the server.
A geolocation object that was derived by IP address of the connection established with the server.
The lower IP address range, which is used internally on the server to segment it into a geolocation bucket.
The upper IP address range, which is used internally on the server to segment it into a geolocation bucket.
The ISO country code, used to standardize the name of the country.
The name of the country
In the US, this is the full name of the state. In other parts of the world it may be the full name of a province or state.
The full name of the city.
true if the region is blocked and may not trade from it or false if it can trade.
true if the account or region must adhere to Dolomite's compliance practices or false if it may connect freely.
The IP Address could not be pinpointed to any specific region.
Response Example (200 OK)
{
"global_objects": {},
"data": {
"from_ip_address": "69.121.32.0",
"to_ip_address": "69.121.32.255",
"country_code": "US",
"country": "United States",
"region": "New Jersey",
"city": "Jersey City",
"is_blocked_region": false,
"is_compliance_required": false
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Address Information
Account by Address
Gets an account's public information, based on the corresponding address.
A crypto currency address.
The account that is tied to the corresponding address.
The account's wallet information.
The cryptocurrency wallet address tied to this operation.
The timestamp at which this item was created, in milliseconds since the Unix epoch.
The user's smart wallet address for depositing funds to trade.
Denotes whether the deposit wallet address is the smart contract wallet address.
true if the Dolomite Direct deposit contract has been created for this owner or false if it has not.
The address of the entity that can trade on the owner address's behalf. This is used mainly for managed accounts, to simplify access to Dolomite's decentralized exchange.
This address's referral code that can be given to other traders upon sign-up. Signing up other users grants this address all of the benefits of the referral program, like earning commission from the signed-up-user's trades.
The type of wallet will be either managed or unmanaged.
MANAGED UNMANAGED Universally unique identifier (UUID) representing an account on Dolomite.
Gateway status allowing for certain actions on the exchange. The ACTIVE status indicates the account is fully approved (or tier 4 verified).
STANDBY PENDING ACTIVE REJECTED CLOSED The address that referred this trader to Dolomite.
The metadata associated with an account. This is customizable by the client-side server through different endpoints.
true if the account or region must adhere to Dolomite's compliance practices or false if it may connect freely.
Account's current verification tier number.
0 1 2 3 4 Verification tier number in which an account is upgrading to.
0 1 2 3 4 Verification tier number in which an account previously failed to upgrade to.
0 1 2 3 4 The aggregate trading limits that are imposed on this account due over the current 24-hour window.
The aggregate amount, in USD, this account has open in trades. This is the sum of the USD value of all OPEN orders.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total amount that this account has traded today. This is important when looking at this account's trade limits, since it plays into the total amount a non-tier-4 account may trade on a daily basis. This number resets to 0 at 00:00:00 UTC.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
(no description)
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total amount that this account has traded today, plus the amount of open orders this account has. This is important when looking at this account's trade limits, since it plays into the total amount a non-tier-4 account may trade on a daily basis.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
A list of the different fiat service providers to which the user linked their Dolomite account.
A list of the different account types for which the user can create (through Dolomite) to access fiat services.
There is no account tied to the corresponding address.
Response Example (200 OK)
{
"global_objects": {},
"data": {
"wallet": {
"wallet_address": "0x0000000000000000000000000000000000000000",
"creation_timestamp": 1557723502000,
"deposit_wallet_address": "0x0000000000000000000000000000000000000000",
"is_smart_wallet_address": "boolean",
"is_deposit_contract_created": "boolean",
"broker_address": "0x0000000000000000000000000000000000000000",
"referral_code": "123456",
"wallet_type": "MANAGED"
},
"dolomite_account_id": "be2d09ef-3246-4a2b-a1b2-6f7546ec2c5f",
"account_gateway_status": "string",
"referrer_address": "0x0000000000000000000000000000000000000000",
"account_metadata": "object",
"is_compliance_required": false,
"current_verification_tier_number": "integer (int32)",
"upgrading_to_verification_tier_number": "integer (int32)",
"failed_upgrading_to_verification_tier_number": "integer (int32)",
"limits": {
"open_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_filled_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_max_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_used_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"linked_fiat_providers": "[NATIVE_WYRE]",
"supported_fiat_providers": "[NATIVE_WYRE]"
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Rebates by Address
Gets all of the rebates that the address has earned.
A crypto currency address.
A rebates map from ticker ⇒ amount which contains the address's rebates.
key ] {
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The address was formatted correctly but the address could not be found on the exchange.
Response Example (200 OK)
{
"global_objects": {},
"data": {
"$key": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Balances by Address
Gets the token balances of an address and groups them by ticker which is the key in the JSON object.
A crypto currency address.
The address of the entity that can trade on the owner address's behalf. This is used mainly for managed accounts, to simplify access to Dolomite's decentralized exchange.
A balance map from ticker ⇒ amount which contains the address's balance information.
key ] {
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The address was formatted correctly but the address could not be found on the exchange.
Response Example (200 OK)
{
"global_objects": {},
"data": {
"$key": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Portfolios by Address
Gets portfolios for for all of the tickers associated a given address. This is grouped by a ticker, which is the key in the JSON object.
A crypto currency address.
This can be specified to retrieve portfolio's of selected tickers. If not specified, all portfolios for the given address will be returned.
The address of the entity that can trade on the owner address's behalf. This is used mainly for managed accounts, to simplify access to Dolomite's decentralized exchange.
A map of key ⇒ portfolio that contains basic information about an address's holdings.
key ] {
The token that describes this portfolio.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The cryptocurrency address of the user who owns and created the order.
The total amount this address has in their wallet.
The total amount that this address has authorized the Loopring Delegate address to trade on this address's behalf. This must be non-zero to enable trading. To find the DelegateAddress, hit the Exchange Information route.
The total amount that this address has frozen in trades. This is the sum of fees needed to be paid and order amounts.
The address and query param tickers (if specified) inputted are formatted correctly and but one of these inputs are not present on Dolomite.
Response Example (200 OK)
{
"global_objects": {},
"data": {
"$key": {
"asset": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
},
"owner_address": "0x0000000000000000000000000000000000000000",
"balance": "100000000000000000000",
"allowance": "100000000000000000000",
"committed": "100000000000000000000"
}
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Subscribe to Portfolios by Address
Sends a message up to watch for realtime updates to this address's portfolios. This can be when tokens are transferred, orders are placed, filled, or etc., or allowances change.
The peration to perform or that was performed.
subscribe unsubscribe A container object that wraps criteria for websocket upstream requests.
A crypto currency address.
The address of the entity that can trade on the owner address's behalf. This is used mainly for managed accounts, to simplify access to Dolomite's decentralized exchange.
The path at which the corresponding action will be performed for upstream requests. For downstream messages this corresponds to a resource that changed in real-time.
Request Example
{
"action": "subscribe",
"data": {
"address": "0x0000000000000000000000000000000000000000",
"broker_address": "0x0000000000000000000000000000000000000000"
},
"route": "string"
}
A map of key ⇒ portfolio that contains basic information about an address's holdings.
The token that describes this portfolio.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The cryptocurrency address of the user who owns and created the order.
The total amount this address has in their wallet.
The total amount that this address has authorized the Loopring Delegate address to trade on this address's behalf. This must be non-zero to enable trading. To find the DelegateAddress, hit the Exchange Information route.
The total amount that this address has frozen in trades. This is the sum of fees needed to be paid and order amounts.
Response Example (200 OK)
[
{
"asset": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
},
"owner_address": "0x0000000000000000000000000000000000000000",
"balance": "100000000000000000000",
"allowance": "100000000000000000000",
"committed": "100000000000000000000"
}
]
Receive Portfolios by Address
The websocket sends messages down to the client whenever there are portfolio changes with the corresponding address.
A map of key ⇒ portfolio that contains basic information about an address's holdings.
The token that describes this portfolio.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The cryptocurrency address of the user who owns and created the order.
The total amount this address has in their wallet.
The total amount that this address has authorized the Loopring Delegate address to trade on this address's behalf. This must be non-zero to enable trading. To find the DelegateAddress, hit the Exchange Information route.
The total amount that this address has frozen in trades. This is the sum of fees needed to be paid and order amounts.
Response Example (200 OK)
[
{
"asset": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
},
"owner_address": "0x0000000000000000000000000000000000000000",
"balance": "100000000000000000000",
"allowance": "100000000000000000000",
"committed": "100000000000000000000"
}
]
Subscribe to an Account by Address
Sends a message up to watch for realtime updates to this address's account.
The peration to perform or that was performed.
subscribe unsubscribe A container object that wraps criteria for websocket upstream requests.
A crypto currency address.
The path at which the corresponding action will be performed for upstream requests. For downstream messages this corresponds to a resource that changed in real-time.
Request Example
{
"action": "subscribe",
"data": {
"address": "0x0000000000000000000000000000000000000000"
},
"route": "string"
}
An account object that corresponds to the provided address.
The account's wallet information.
The cryptocurrency wallet address tied to this operation.
The timestamp at which this item was created, in milliseconds since the Unix epoch.
The user's smart wallet address for depositing funds to trade.
Denotes whether the deposit wallet address is the smart contract wallet address.
true if the Dolomite Direct deposit contract has been created for this owner or false if it has not.
The address of the entity that can trade on the owner address's behalf. This is used mainly for managed accounts, to simplify access to Dolomite's decentralized exchange.
This address's referral code that can be given to other traders upon sign-up. Signing up other users grants this address all of the benefits of the referral program, like earning commission from the signed-up-user's trades.
The type of wallet will be either managed or unmanaged.
MANAGED UNMANAGED Universally unique identifier (UUID) representing an account on Dolomite.
Gateway status allowing for certain actions on the exchange. The ACTIVE status indicates the account is fully approved (or tier 4 verified).
STANDBY PENDING ACTIVE REJECTED CLOSED The address that referred this trader to Dolomite.
The metadata associated with an account. This is customizable by the client-side server through different endpoints.
true if the account or region must adhere to Dolomite's compliance practices or false if it may connect freely.
Account's current verification tier number.
0 1 2 3 4 Verification tier number in which an account is upgrading to.
0 1 2 3 4 Verification tier number in which an account previously failed to upgrade to.
0 1 2 3 4 The aggregate trading limits that are imposed on this account due over the current 24-hour window.
The aggregate amount, in USD, this account has open in trades. This is the sum of the USD value of all OPEN orders.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total amount that this account has traded today. This is important when looking at this account's trade limits, since it plays into the total amount a non-tier-4 account may trade on a daily basis. This number resets to 0 at 00:00:00 UTC.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
(no description)
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total amount that this account has traded today, plus the amount of open orders this account has. This is important when looking at this account's trade limits, since it plays into the total amount a non-tier-4 account may trade on a daily basis.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
A list of the different fiat service providers to which the user linked their Dolomite account.
A list of the different account types for which the user can create (through Dolomite) to access fiat services.
Response Example (200 OK)
{
"wallet": {
"wallet_address": "0x0000000000000000000000000000000000000000",
"creation_timestamp": 1557723502000,
"deposit_wallet_address": "0x0000000000000000000000000000000000000000",
"is_smart_wallet_address": "boolean",
"is_deposit_contract_created": "boolean",
"broker_address": "0x0000000000000000000000000000000000000000",
"referral_code": "123456",
"wallet_type": "MANAGED"
},
"dolomite_account_id": "be2d09ef-3246-4a2b-a1b2-6f7546ec2c5f",
"account_gateway_status": "string",
"referrer_address": "0x0000000000000000000000000000000000000000",
"account_metadata": "object",
"is_compliance_required": false,
"current_verification_tier_number": "integer (int32)",
"upgrading_to_verification_tier_number": "integer (int32)",
"failed_upgrading_to_verification_tier_number": "integer (int32)",
"limits": {
"open_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_filled_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_max_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_used_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"linked_fiat_providers": "[NATIVE_WYRE]",
"supported_fiat_providers": "[NATIVE_WYRE]"
}
Receive an Account by Address
The websocket sends messages down to the client whenever the corresponding address changes.
An account object that corresponds to the provided address.
The account's wallet information.
The cryptocurrency wallet address tied to this operation.
The timestamp at which this item was created, in milliseconds since the Unix epoch.
The user's smart wallet address for depositing funds to trade.
Denotes whether the deposit wallet address is the smart contract wallet address.
true if the Dolomite Direct deposit contract has been created for this owner or false if it has not.
The address of the entity that can trade on the owner address's behalf. This is used mainly for managed accounts, to simplify access to Dolomite's decentralized exchange.
This address's referral code that can be given to other traders upon sign-up. Signing up other users grants this address all of the benefits of the referral program, like earning commission from the signed-up-user's trades.
The type of wallet will be either managed or unmanaged.
MANAGED UNMANAGED Universally unique identifier (UUID) representing an account on Dolomite.
Gateway status allowing for certain actions on the exchange. The ACTIVE status indicates the account is fully approved (or tier 4 verified).
STANDBY PENDING ACTIVE REJECTED CLOSED The address that referred this trader to Dolomite.
The metadata associated with an account. This is customizable by the client-side server through different endpoints.
true if the account or region must adhere to Dolomite's compliance practices or false if it may connect freely.
Account's current verification tier number.
0 1 2 3 4 Verification tier number in which an account is upgrading to.
0 1 2 3 4 Verification tier number in which an account previously failed to upgrade to.
0 1 2 3 4 The aggregate trading limits that are imposed on this account due over the current 24-hour window.
The aggregate amount, in USD, this account has open in trades. This is the sum of the USD value of all OPEN orders.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total amount that this account has traded today. This is important when looking at this account's trade limits, since it plays into the total amount a non-tier-4 account may trade on a daily basis. This number resets to 0 at 00:00:00 UTC.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
(no description)
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total amount that this account has traded today, plus the amount of open orders this account has. This is important when looking at this account's trade limits, since it plays into the total amount a non-tier-4 account may trade on a daily basis.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
A list of the different fiat service providers to which the user linked their Dolomite account.
A list of the different account types for which the user can create (through Dolomite) to access fiat services.
Response Example (200 OK)
{
"wallet": {
"wallet_address": "0x0000000000000000000000000000000000000000",
"creation_timestamp": 1557723502000,
"deposit_wallet_address": "0x0000000000000000000000000000000000000000",
"is_smart_wallet_address": "boolean",
"is_deposit_contract_created": "boolean",
"broker_address": "0x0000000000000000000000000000000000000000",
"referral_code": "123456",
"wallet_type": "MANAGED"
},
"dolomite_account_id": "be2d09ef-3246-4a2b-a1b2-6f7546ec2c5f",
"account_gateway_status": "string",
"referrer_address": "0x0000000000000000000000000000000000000000",
"account_metadata": "object",
"is_compliance_required": false,
"current_verification_tier_number": "integer (int32)",
"upgrading_to_verification_tier_number": "integer (int32)",
"failed_upgrading_to_verification_tier_number": "integer (int32)",
"limits": {
"open_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_filled_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_max_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
},
"daily_used_trade_amount_usd": {
"amount": "100000000000000000000",
"currency": {
"ticker": "string",
"precision": "integer (int32)",
"display_precision": "integer (int32)"
}
}
},
"linked_fiat_providers": "[NATIVE_WYRE]",
"supported_fiat_providers": "[NATIVE_WYRE]"
}
Tokens
All Tokens
Gets all the tokens that Dolomite currently supports.
A list of tokens that are supported by the exchange or are registered in the system.
The unique ID that Dolomite assigned this token.
The type of token that a cryptocurrency is classified as. For example, Ethereum tokens are classified as an ERC20 token_type.
BTC NEO NEP5 ETH ERC20 COIN TOKEN The version number of this token
A unique and universal way to identify a cryptocurrency. For ERC20 tokens, this is the token's contract address. For major cryptocurrencies like
Ethereum and
Bitcoin, it's their ticker (ETH and BTC respectively). For all other assets, it defaults to the DolomiteTokenId.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The currency's name.
The name of the currency, in its singular form.
The name of the currency, in its plural form.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
A URL that points to a scaled-down image, for use in smaller places.
A URL that points to a full-scale image.
The date at which the token was added to the platform.
Response Example (200 OK)
{
"global_objects": {},
"data": [
{
"dolomite_token_id": 1934,
"token_type": "ERC20",
"version_number": 1,
"identifier": "0x0000000000000000000000000000000000000000",
"ticker": "LRC",
"name": {
"singular": "Bitcoin",
"plural": "Bitcoins"
},
"display_precision": 8,
"precision": 18,
"thumbnail_url": "string",
"image_url": "string",
"date_added": "string (date-time)"
}
],
"paging_metadata": null,
"cursor": null,
"error": null
}
All Quote Tokens
The tokens that Dolomite currently supports as quote tokens, or tokens that can be found as secondaryTickers in a market.
The quote tokens that are currently supported on the exchange.
The unique ID that Dolomite assigned this token.
The type of token that a cryptocurrency is classified as. For example, Ethereum tokens are classified as an ERC20 token_type.
BTC NEO NEP5 ETH ERC20 COIN TOKEN The version number of this token
A unique and universal way to identify a cryptocurrency. For ERC20 tokens, this is the token's contract address. For major cryptocurrencies like
Ethereum and
Bitcoin, it's their ticker (ETH and BTC respectively). For all other assets, it defaults to the DolomiteTokenId.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The currency's name.
The name of the currency, in its singular form.
The name of the currency, in its plural form.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
A URL that points to a scaled-down image, for use in smaller places.
A URL that points to a full-scale image.
The date at which the token was added to the platform.
Response Example (200 OK)
{
"global_objects": {},
"data": [
{
"dolomite_token_id": 1934,
"token_type": "ERC20",
"version_number": 1,
"identifier": "0x0000000000000000000000000000000000000000",
"ticker": "LRC",
"name": {
"singular": "Bitcoin",
"plural": "Bitcoins"
},
"display_precision": 8,
"precision": 18,
"thumbnail_url": "string",
"image_url": "string",
"date_added": "string (date-time)"
}
],
"paging_metadata": null,
"cursor": null,
"error": null
}
Token by Ticker
Gets a token by the provided ticker.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The corresponding ticker's token.
The unique ID that Dolomite assigned this token.
The type of token that a cryptocurrency is classified as. For example, Ethereum tokens are classified as an ERC20 token_type.
BTC NEO NEP5 ETH ERC20 COIN TOKEN The version number of this token
A unique and universal way to identify a cryptocurrency. For ERC20 tokens, this is the token's contract address. For major cryptocurrencies like
Ethereum and
Bitcoin, it's their ticker (ETH and BTC respectively). For all other assets, it defaults to the DolomiteTokenId.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The currency's name.
The name of the currency, in its singular form.
The name of the currency, in its plural form.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
A URL that points to a scaled-down image, for use in smaller places.
A URL that points to a full-scale image.
The date at which the token was added to the platform.
The provided ticker was not formatted correctly.
The provided ticker was is not present on the exchange nor registered in the system.
Response Example (200 OK)
{
"global_objects": {},
"data": {
"dolomite_token_id": 1934,
"token_type": "ERC20",
"version_number": 1,
"identifier": "0x0000000000000000000000000000000000000000",
"ticker": "LRC",
"name": {
"singular": "Bitcoin",
"plural": "Bitcoins"
},
"display_precision": 8,
"precision": 18,
"thumbnail_url": "string",
"image_url": "string",
"date_added": "string (date-time)"
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Exchange Rates
Gets the most updated conversion rates for the assets on Dolomite.
A map of ticker ⇒ tokenWithConversionRate object.
key ] {
The unique ID that Dolomite assigned this token.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The currency's name.
The name of the currency, in its singular form.
The name of the currency, in its plural form.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The date at which the token was added to the platform.
A URL that points to a scaled-down image, for use in smaller places.
A URL that points to a full-scale image.
A unique and universal way to identify a cryptocurrency. For ERC20 tokens, this is the token's contract address. For major cryptocurrencies like
Ethereum and
Bitcoin, it's their ticker (ETH and BTC respectively). For all other assets, it defaults to the DolomiteTokenId.
The version number of this token
An object that expands to show the token's price in multiple currencies.
key ] {
This denotes the conversion rate or price between the two currencies. In a market, it is always measured as amountSecondary ÷ amountPrimary.
The type of token that a cryptocurrency is classified as. For example, Ethereum tokens are classified as an ERC20 token_type.
BTC NEO NEP5 ETH ERC20 COIN TOKEN Response Example (200 OK)
{
"global_objects": {},
"data": {
"$key": {
"dolomite_token_id": 1934,
"display_precision": 8,
"precision": 18,
"name": {
"singular": "Bitcoin",
"plural": "Bitcoins"
},
"ticker": "LRC",
"date_added": "string (date-time)",
"thumbnail_url": "string",
"image_url": "string",
"identifier": "0x0000000000000000000000000000000000000000",
"version_number": 1,
"quote": {
"LRC": {
"exchange_rate": 168.12345678
}
},
"token_type": "ERC20"
}
},
"paging_metadata": null,
"cursor": null,
"error": null
}
Subscribe to Exchange Rates
Send a message up to watch for realtime updates of the fiat exchange rates of the supported markets on Dolomite.
The peration to perform or that was performed.
subscribe unsubscribe The path at which the corresponding action will be performed for upstream requests. For downstream messages this corresponds to a resource that changed in real-time.
Request Example
{
"action": "subscribe",
"route": "string"
}
A map of ticker ⇒ tokenWithConversionRate object.
key ] {
The unique ID that Dolomite assigned this token.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The currency's name.
The name of the currency, in its singular form.
The name of the currency, in its plural form.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The date at which the token was added to the platform.
A URL that points to a scaled-down image, for use in smaller places.
A URL that points to a full-scale image.
A unique and universal way to identify a cryptocurrency. For ERC20 tokens, this is the token's contract address. For major cryptocurrencies like
Ethereum and
Bitcoin, it's their ticker (ETH and BTC respectively). For all other assets, it defaults to the DolomiteTokenId.
The version number of this token
An object that expands to show the token's price in multiple currencies.
key ] {
This denotes the conversion rate or price between the two currencies. In a market, it is always measured as amountSecondary ÷ amountPrimary.
The type of token that a cryptocurrency is classified as. For example, Ethereum tokens are classified as an ERC20 token_type.
BTC NEO NEP5 ETH ERC20 COIN TOKEN Response Example (200 OK)
{
"$key": {
"dolomite_token_id": 1934,
"display_precision": 8,
"precision": 18,
"name": {
"singular": "Bitcoin",
"plural": "Bitcoins"
},
"ticker": "LRC",
"date_added": "string (date-time)",
"thumbnail_url": "string",
"image_url": "string",
"identifier": "0x0000000000000000000000000000000000000000",
"version_number": 1,
"quote": {
"LRC": {
"exchange_rate": 168.12345678
}
},
"token_type": "ERC20"
}
}
Receive Exchange Rates
The websocket sends messages down to the client periodically (less than every 60 seconds) with the most updated fiat exchange rates.
A map of ticker ⇒ tokenWithConversionRate object.
key ] {
The unique ID that Dolomite assigned this token.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The currency's name.
The name of the currency, in its singular form.
The name of the currency, in its plural form.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The date at which the token was added to the platform.
A URL that points to a scaled-down image, for use in smaller places.
A URL that points to a full-scale image.
A unique and universal way to identify a cryptocurrency. For ERC20 tokens, this is the token's contract address. For major cryptocurrencies like
Ethereum and
Bitcoin, it's their ticker (ETH and BTC respectively). For all other assets, it defaults to the DolomiteTokenId.
The version number of this token
An object that expands to show the token's price in multiple currencies.
key ] {
This denotes the conversion rate or price between the two currencies. In a market, it is always measured as amountSecondary ÷ amountPrimary.
The type of token that a cryptocurrency is classified as. For example, Ethereum tokens are classified as an ERC20 token_type.
BTC NEO NEP5 ETH ERC20 COIN TOKEN Response Example (200 OK)
{
"$key": {
"dolomite_token_id": 1934,
"display_precision": 8,
"precision": 18,
"name": {
"singular": "Bitcoin",
"plural": "Bitcoins"
},
"ticker": "LRC",
"date_added": "string (date-time)",
"thumbnail_url": "string",
"image_url": "string",
"identifier": "0x0000000000000000000000000000000000000000",
"version_number": 1,
"quote": {
"LRC": {
"exchange_rate": 168.12345678
}
},
"token_type": "ERC20"
}
}
Markets
Market
Gets a specific trading pair, based on the provided market, and returns some basic market information based on the provided period.
A pair that consists of a primary ticker and a secondary ticker, formatted as PRIMARY-SECONDARY.
The time frame through which any metrics should be calculated. For example, specifying a period of ONE_DAY indicates that metrics should measured over a 1-day period.
The trading pair of the provided market, as well as some of their basic market information.
A pair that consists of a primary ticker and a secondary ticker, formatted as PRIMARY-SECONDARY.
The ticker of the token that must be paid as the fee for this market for spot trading. Margin trading may have different rules.
The period in which this metric was collected over.
ONE_HOUR ONE_DAY ONE_WEEK ONE_MONTH The highest price recorded for this market over the corresponding metric_period.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The lowest price recorded for this market over the corresponding metric_period.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total volume of primaryTicker over the corresponding metric_period.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total volume recorded, in terms of secondaryTicker over the corresponding metric_period.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The total volume recorded, in terms of USD over the corresponding metric_period. This is calculated by multiplying the current exchange rate by the secondary volume.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The percent change in price over the corresponding metric_period.
The highest bid currently on the order books for this market.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The lowest ask currently on the order books for this market
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The current price on the order books for this market, which is calculated as (highestBid + lowestAsk) ÷ 2).
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
The last price at which an order was settled for the given market. This is measured in terms of the secondaryTicker.
The quantity of this item. This is formatted as a big number, so it is always wrapped in quotes, as a string.
An asset that can be described via quantity. This field usually contains a precision as well as a display_precision for describing how many decimal places it has for when it displays numbers as paddedNumbers.
The short symbol used to identify a token instead of using its full name. For example, Bitcoin's ticker is BTC.
The max number of decimal places this number can contain. For example, a precision of 18 (which is the precision of ETH) means that there can be at-most 18 decimal places.
The number of decimal places that should be shown for this number, for display purposes. Oftentimes we use this number because the max scale of a number is too small.
true if Dolomite supports margin trading for this market via dYdX or false if it does not.
The object containing the Dydx primary and secondary market ids.
dYdX uses IDs to represent their tokens rather than addresses, so we must send an ID to perform an action using their protocol. This is for the primary token of the market.