Get started

API Endpoint

    https://exchange.solidus.finance/api
                

Base URL: https://exchange.solidus.finance/api

The SolidusAPI v1.0 is a REST API that allows third-party services to interface with the functionality of Solidus.

If you find any issues with the API, please report them to the Solidus dev team. When making a report, please make sure to provide extensive details about the issue, including, but not limited to:

  • Endpoint URL
  • Type of request (GET or POST)
  • Contents of said request
  • Information about web browser
  • Desired result (what you expected the API to respond with)

If you have any further questions regarding the API, its functions, or anything of that nature, please visit our discord server

GET PAIRS


curl https://exchange.solidus.finance/api/v1/markets 

[
   {
        "name":"BTC_USDT",
        "last_price":"100.00000000",
        "volume":"0.00000000",
        "change_24h":"-87.64000000",
        "high":"1005.00000000",
        "low":"10.00000000",
        "bid":101.11111110,
        "ask":112.00000000
   },
   {
        "name":"SLDS_BTC",
        "last_price":"0.00020000",
        "volume":"0.00000000",
        "change_24h":"0.00000000",
        "high":"3.00000000",
        "low":"0.00002000",
        "bid":0.00100000,
        "ask":0
   }
   ...
]
                

GET https://exchange.solidus.finance/api/v1/markets

Returns all available coin pairs currently offered plus some extra information


RESPONSE

Field Type Description
name string pair name
last_price float last price the pair was traded at
volume float total trading volume of the coin pair in over the past 24 hours
change_24h float change of value of the coin pair in the past 24 hours (in percentage)
high float highest price of the coin pair over the past 24 hours
low float lowest price of the coin pair over the past 24 hours
bid float current bid price for the coin pair
ask float current ask price for the coin pair

ORDER BOOK


curl https://exchange.solidus.finance/api/v1/book/BTC_USDT

[
    {
        "type":"BUY",
        "amount":"5.98415000",
        "price":"10.00000000"
    },
        {
        "type":"BUY",
        "amount":"5.98415000",
        "price":"10.00000000"
    },
        {
       "type":"BUY",
        "amount":"5.98415000",
        "price":"10.00000000"
    },
        {
        "type":"SELL",
        "amount":"5.98415000",
        "price":"10.00000000"
    },
    ... 
]
                

GET https://exchange.solidus.finance/api/v1/book/{coin-pair}

Returns the orderbook for a given coin pair


RESPONSE

Field Type Description
type string type of order posted for a given coin pair
amount float amount of coins the order contains
price float the listing price that an order sells for

RECENT TRADES


curl https://exchange.solidus.finance/api/v1/orders/BTC_USDT

[
    {
        "amount": "0.01000000",
        "market": "BTC_USDT",
        "price": "100.00000000",
        "trade_time": "2021-06-12 16:18:21",
        "type": "SELL"
    },
    {
        "amount": "0.01000000",
        "market": "BTC_USDT",
        "price": "100.00000000",
        "trade_time": "2021-05-23 19:31:38",
        "type": "SELL"
    }             
    ...
]
                

GET https://exchange.solidus.finance/api/v1/orders/{coin-pair}

Returns the latest trades for a given coin pair


RESPONSE

Field Type Description
amount string amount of coins the order contained
market string coin pair in which the trade was conducted in
price float the listing price that an order sells for
trade_time date timestamp in which the order was executed successfully
type string type of order posted for a given coin pair

BALANCES


curl "https://exchange.solidus.finance/api/v1/balances" 
--header "api-key: d5c06bd20a48-34e3bb670874-73b79095fc39-de099abc6e1b" 

[
    {
        "ticker":"BTC",
        "balance":"0.51605007",
        "balance_orders":"1.81510000"
    },
    {
        "ticker":"SLDS",
        "balance":"0.00514766",
        "balance_orders":"0.00000000"
    },
    {
        "ticker":"USDT",
        "balance":"1378.37394755",
        "balance_orders":"1323.30451264"
    },
    {
        "ticker":"LTC",
        "balance":"0.00000000",
        "balance_orders":"0.00000000"
    },
    ...
]
                

GET https://exchange.solidus.finance/api/v1/balances

Returns the balances of all the wallets from a given user


PARAMETERS

Field Type Description
api-key (header) string API key required to access sensitive information about a given user

RESPONSE

Field Type Description
ticker string shorthand identifier for a given coin
balance float total amount currently held in a given wallet by the user
balance_orders float balance that is being actively used in open orders

OPEN ORDERS


curl "https://exchange.solidus.finance/api/v1/openorders/BTC_USDT" 
--header "api-key: d5c06bd20a48-34e3bb670874-73b79095fc39-de099abc6e1b"

[
    {
        "id":1074,
        "type":"SELL",
        "amount":"0.01000000",
        "price":"1000.00000000"
    },
    {
        "id":1075,
        "type":"SELL",
        "amount":"0.01000000",
        "price":"10000.00000000"
    },
    {
        "id":1076,
        "type":"SELL",
        "amount":"0.01000000",
        "price":"100000.00000000"
    }
    ...
]
                

GET https://exchange.solidus.finance/api/v1/openorders/{coin-pair}

Returns all the open orders for a given user


PARAMETERS

Field Type Description
api-key (header) string API key required to access sensitive information about a given user

RESPONSE

Field Type Description
id string an unique identifier that identifies that given order
type string type of order posted for a given coin pair
amount float amount of coins the order contains
price float the listing price that an order sells for

DEPOSIT ADDRESSES


curl "https://exchange.solidus.finance/api/v1/deposit_addresses" 
--header "api-key: d5c06bd20a48-34e3bb670874-73b79095fc39-de099abc6e1b"

[
    {
        "ticker":"BTC",
        "address":"bc1qg8qz9m848k8fcjw24rw3v0cxh07g4xm3txskty"
    },
    {
        "ticker":"SLDS",
        "address":"SQQb87V7xyJYcSjFv69NmanGNGfm75AnBX"
    },
    {
        "ticker":"USDT",
        "address":"0x8cE6662D72Bc543FEd76AAdEca5ADDe4DC35AA22"
    },
    {
        "ticker":"LTC",
        "address":"no_address"
    },
    {
        "ticker":"ETH",
        "address":"0x8cE6662D72Bc543FEd76AAdEca5ADDe4DC35AA22"
    },
    {
        "ticker":"XMR",
        "address":"9zSum4VwfBw5uoX1QzRVN7DFgKe3YvHVsC1iybB1eRqv7yn5qVc7PuZ3zPuympiXTn49Eg1N99pSUEYsvKuoLAd99rmC8ZA"
    },
    {
        "ticker":"WCN",
        "address":"no_address"
    }
    ...
]
                

GET https://exchange.solidus.finance/api/v1/deposit_addresses

Returns the exchange wallet addresses for a given user


PARAMETERS

Field Type Description
api-key (header) string API key required to access sensitive information about a given user

RESPONSE

Field Type Description
ticker string shorthand identifier for a given coin
address string cryptocurrency wallet address

DELETE ORDER


curl "https://exchange.solidus.finance/api/v1/delete_order" 
-d "orderid=1&market=BTC_USDT" -X POST 
--header "api-key: d5c06bd20a48-34e3bb670874-73b79095fc39-de099abc6e1b"

[
    {
        "status":"Success"
    }
]
                

POST https://exchange.solidus.finance/api/v1/delete_order

Delete an order new order on the exchange


PARAMETERS

Field Type Description
orderid string specifies the orderid that will be deleted
market string specifies in which market the order will be deleted in
api-key (header) string API key required to access sensitive information about a given user

RESPONSE

Field Type Description
status string specifies whether the trade was deleted successfully or failed

PLACE ORDER


curl "https://exchange.solidus.finance/api/v1/place_order" 
-d "amountbuy=1&pricebuy=1000&market=BTC_USDT" -X POST 
--header "api-key: d5c06bd20a48-34e3bb670874-73b79095fc39-de099abc6e1b"

curl "https://exchange.solidus.finance/api/v1/place_order" 
-d "amountsell=1&pricesell=1000&market=BTC_USDT" -X POST 
--header "api-key: d5c06bd20a48-34e3bb670874-73b79095fc39-de099abc6e1b"

[
    {
        "status":"Success"
    }
]
                

POST https://exchange.solidus.finance/api/v1/place_order

Place an order new order on the exchange


PARAMETERS

Field Type Description
amountbuy/amountsell string specifies the amount that will be placed
pricebuy/pricesell string specifies the price of the order that will be placed
market string specifies in which market the order will be placed in
api-key (header) string API key required to access sensitive information about a given user

RESPONSE

Field Type Description
status string specifies whether the trade was placed successfully or failed