API

.NET Library

https://github.com/southxchange/SouthXchange-.NET-API-Library

WebSocket Example

https://market.southxchange.com/content/websocket.txt

PUBLIC DATA

MARKETS

Lists all markets

GET https://market.southxchange.com/api/markets

See example

Field	Description
Array of [Market entry]
[Market entry] (Array)
Index 0	Listing currency code
Index 1	Reference currency code

MARKETS (Version 2)

Lists all markets

GET https://market.southxchange.com/api/v2/markets

See example

Field	Description
Array of [Market entry]
[Market entry] (Array)
Index 0	Listing currency code
Index 1	Reference currency code
Index 2	Market ID

PRICE

Gets price of a given market

GET https://market.southxchange.com/api/price/{listingCurrencyCode}/{referenceCurrencyCode}

See example

Field	Description
Bid	Highest buy order
Ask	Lowest sell order
Last	Last price
Variation24Hr	Last 24 hours last price variation
Volume24Hr	Last 24 hours volume

PRICES

Lists prices of all markets

GET https://market.southxchange.com/api/prices

See example

Field	Description
Array of [Price entry]
[Price entry]
Market	Market name
Bid	Highest buy order
Ask	Lowest sell order
Last	Last price
Variation24Hr	Last 24 hours last price variation
Volume24Hr	Last 24 hours volume

BOOK

Lists order book of a given market

GET https://market.southxchange.com/api/book/{listingCurrencyCode}/{referenceCurrencyCode}

See example

Field	Description
BuyOrders	Buy orders. Array of [Order entry]
SellOrders	Sell orders. Array of [Order entry]
[Order entry]
Index	Incremental value for each book entry
Amount	Book entry total amount
Price	Book entry price

TRADES

Lists latest trades in a given market

GET https://market.southxchange.com/api/trades/{listingCurrencyCode}/{referenceCurrencyCode}

See example

Field	Description
Array of [Trade entry]
[Trade entry]
At	Execution time in Unix standard format (UTC)
Amount	Amount in listing currency
Price	Price in reference currency
Type	Possible values: buy, sell

HISTORY

List market history between two dates

GET https://market.southxchange.com/api/history/{listingCurrencyCode}/{referenceCurrencyCode}/{start}/{end}/{periods}

See example

Parameters
Field	Description
listingCurrencyCode	Market listing currency
referenceCurrencyCode	Market reference currency
start	Start date in milliseconds from January 1, 1970
end	End date in milliseconds from January 1, 1970
periods	Number of periods to get (Optional: defaults to 100)

Result
Array of [History Entry]
[History Entry]
Date	Start date of the period
PriceHigh	Highest price of the period
PriceLow	Lowest price of the period
PriceOpen	First price of the period
PriceClose	Last price of the period
Volume	Volume of the period

PRIVATE DATA

Rules to use the private API

You need to generate a pair of API key and secret in your account settings.
All methods are sent as POST.
Parameters are sent in the request body as JSON, except for the Hash which is sent as an HTTP header named “Hash”.
There are two parameters that are always needed in the request body: nonce and key (API key). The documentation below will omit these parameters because they are always needed. Hash is also always needed but in the headers.
Nonce is a positive numerical value. You can use any number, but it must be greater than the last nonce you used in the previous request. To avoid keeping track of the nonce you can use a value that will always change, for example a timestamp in milliseconds or microseconds.
Methods will return HTTP 200 when successful, and HTTP 500 when an error occurred.
Hash is the HMAC-SHA512 of the request body (JSON) signed with the secret value. Make sure the encoding is UTF-8.

Parameters
Field	Description
key	API Key
nonce	Positive numerical value greater than the one used in the previous call
Hash (HTTP header)	HMAC-SHA512 of the request body signed with the secret value

PLACE ORDER

Places an order in a given market. Permission required: Place Order

POST https://market.southxchange.com/api/placeOrder

Parameters
Field	Description
listingCurrency	Market listing currency
referenceCurrency	Market reference currency
type	Order type. Possible values: buy, sell
amount	Order amount in listing currency
limitPrice	Optional price in reference currency. If null then order is executed at market price

Result
Order code

CANCEL ORDER

Cancels a given order. Permission required: Cancel Order

POST https://market.southxchange.com/api/cancelOrder

Parameters
Field	Description
orderCode	Order code to cancel

CANCEL MARKET ORDERS

Cancels all orders in a given market. Permission required: Cancel Order

POST https://market.southxchange.com/api/cancelMarketOrders

Parameters
Field	Description
listingCurrency	Market listing currency
referenceCurrency	Market reference currency

LIST ORDERS

Lists all pending orders. Permission required: List Orders

POST https://market.southxchange.com/api/listOrders

Parameters
None

Result
Field	Description
Array of [Order entry]
[Order entry]
Code	Order code
Type	Order type. Possible values: buy, sell
Amount	Pending amount in listing currency
OriginalAmount	Original amount in listing currency
LimitPrice	Order price in reference currency
ListingCurrency	Market listing currency
ReferenceCurrency	Market reference currency

GENERATE NEW ADDRESS

Generates a new address for a given cryptocurrency. Permission required: Generate New Address

POST https://market.southxchange.com/api/generatenewaddress

Parameters
Field	Description
currency	Currency for which a new address will be generated

Result
Address

WITHDRAW

Withdraws to a given address. Permission required: Withdraw

POST https://market.southxchange.com/api/withdraw

Parameters
Field	Description
currency	Currency code to withdraw
address	Destination address
amount	Amount to withdraw. Destination address will receive this amount minus fees

Result
Field	Description
Status	Possible values: ok: withdrawal request succees holdsNotSatisfied: cannot withdraw due to hold in your account limitReached: cannot withdraw due to withdrawal limit
Max	The remaining withdrawal limit
MaxDaily	The daily withdrawal limit
MovementId	ID of this withdrawal

LIST BALANCES

Lists balances for all currencies. Permission required: List Balances

POST https://market.southxchange.com/api/listBalances

Parameters
None

Result
Field	Description
Array of [Balance entry]
[Balance entry]
Currency	Currency code
Deposited	Total amount deposited for this currency code
Available	Total amount that is not committed in orders
Unconfirmed	Total amount unconfirmed in pending deposits

LIST TRANSACTIONS

List all transactions. Permission required: List Balances

POST https://market.southxchange.com/api/listTransactions

Parameters	Description
Currency	Currency code
TransactionType	Transaction type. Possible values: transactions, deposits, withdrawals, depositswithdrawals (Optional: defaults to transactions)
PageIndex	Page index
PageSize	Page size. Maximum: 50
SortField	Sort field
Descending	If [SortField] is descending

Result
Field	Description
Array of [Transaction Entry]
[Transaction Entry]
Date	Date of the transaction
CurrencyCode	The currency code of the transaction. Delisted coins shown as '?'
Amount	Amount of the transaction
TotalBalance	Total balance after this transaction
Type	Possible values: trade, trade fee, deposit, withdraw, etc
Status	Possible values: pending, confirmed, processed, etc
Address	Deposit or withdraw address
Hash	Deposit or withdraw chain transaction hash
Price	Trade price
OtherAmount	Trade amount of the other currency
OtherCurrency	The other trade currency. Delisted coins shown as '?'
OrderCode	Trade order code
TradeId	The ID of the trade
MovementId	Deposit or withdrawal ID

GET LIGHTNING NETWORK INVOICE

Generates a new Lightning Network invoice for a given cryptocurrency. Permission required: Generate New Address

POST https://market.southxchange.com/api/getlninvoice

Parameters	Description
currency	Currency code for which the invoice will be generated. Possible values: BTC, LTC
amount	Invoice amount

Result
Payment request (invoice)

SouthXchange

		Currency	Available	In orders	Total	Actions
	/
		≈ Incoming:	≈	≈	Deposit Withdraw Trade This currency has no related markets ✖