Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
API.md Create API.md May 7, 2019
FAQ.md Update FAQ.md May 31, 2019
README.md Update README.md May 7, 2019

README.md

API Documentation

SwitchDex's API gives you all the functionality of most market API's with more coming down the line. You can query orders,trades,deposits and withdrawals. Most of this content is direct to the smart contract so you can query the contract directly to obtain this information, however the API allows you to setup a websocket listener and act on the information as it comes in.

Socket

There's only one API endpoint, temporarily hosted at:
https://socket.switchdex.ag:8443
This endpoint will likely change in the future, however requests going to this URL will always resolve.

Endpoints

getMarket { token (address), user (address) }

Both arguments are optional. Emit this message and then wait for a market response, which will contain:
{ returnTicker, orders, trades, myOrders, myTrades, myFunds }

message (order)

This allows you to post an order.
(order) should be a JSON object with the following properties:
amountGive: the amount you want to give (in wei or the base unit of the token)
tokenGive: the token you want to give (use the zero address, 0x0000000000000000000000000000000000000000 for ETH)
amountGet: the amount you want to get (in wei or the base unit of the token)
tokenGet: the token you want to get (use the zero address, 0x0000000000000000000000000000000000000000 for ETH)
contractAddr: the EtherDelta smart contract address
expires: the block number when the order should expire
nonce: a random number
user: the address of the user placing the order
v, r, s: the signature of "sha256(contractAddr, tokenGet, amountGet, tokenGive, amountGive, expires, nonce)" after being signed by the user

Events

orders

This will emit new orders as they are placed.
Its structure will mirror that of market.orders, except that some orders will have a deleted flag.
Orders with the deleted flag are no longer valid (canceled or traded).

trades

This will emit new trades as they happen. Its structure will mirror that of market.trades. funds

Rate Limiting

Please keep your connections to a minimum for what you need to do, there is a default rate limit of 6 connections per IP. If you need this increased please ask us on telegram.

Further Notes

There will be more detail coming in the future about the API with some examples, but right now this should be enough information to get you going.
Please keep in mind that this is a work in progress but also a decentralized exchange. Once you've placed a trade there is no way for us to reverse that trade.
If you're in doubt of how to use these functions or need more clarification please ask.
We've tried to keep all endpoints and events similar to what's out there currently for ease of use.

You can’t perform that action at this time.