API

Independent Reserve features a JSON based HTTP API that is comprised of Public and Private endpoints.

• All calls are made over SSL to https://api.independentreserve.com
• Public methods do not require an authentication token and should be accessed via HTTP GET.
• Private methods require a valid authentication token and are accessed via HTTP POST.
• Ensure that the contentType of the your JSON POST is set to application/json.
• The client can receive a compressed response by adding header Accept-Encoding: gzip, deflate

We also support WebSockets.

Refer to the table below for the the decimal places supported when placing orders. On Independent Reserve, a cryptocurrency is defined as a primary currency, a fiat currency as a secondary currency.

Public methods should be accessed via HTTP GET and do not require an authentication token to be passed.

The following public API methods are available:

• GetValidPrimaryCurrencyCodes
• GetValidSecondaryCurrencyCodes
• GetValidLimitOrderTypes
• GetValidMarketOrderTypes
• GetValidOrderTypes
• GetValidTransactionTypes
• GetPrimaryCurrencyConfig
• GetMarketSummary
• GetOrderBook
• GetAllOrders
• GetTradeHistorySummary
• GetRecentTrades
• GetFxRates
• GetOrderMinimumVolumes
• GetDepositFees
• GetFiatWithdrawalFees
• GetCryptoWithdrawalFees

Returns a list of valid primary currency codes. These are the cryptocurrencies which can be traded on Independent Reserve.

This method does not take any parameters.

Returns a list of valid secondary currency codes. These are the fiat currencies which are supported by Independent Reserve for trading purposes.

This method does not take any parameters.

Returns a list of valid limit order types which can be placed onto the Independent Reserve exchange platform.

This method does not take any parameters.

Returns a list of valid market order types which can be placed onto the Independent Reserve exchange platform.

This method does not take any parameters.

Returns a list of all valid order types which can be placed onto the Independent Reserve exchange platform.

This method does not take any parameters.

Returns a list of valid transaction types.

This method does not take any parameters.

Returns the configuration of all primary currencies.

This method does not take any parameters.

Return value descriptions

• IsTradeEnabled - Indicates whether trading is temporarily enabled/disabled
• IsDepositEnabled - Indicates whether deposits are temporarily enabled/disabled
• IsWithdrawalEnabled - Indicates whether withdrawals are temporarily enabled/disabled
• IsDelisted - When set to true, a permanent delisting has occurred. Only withdrawals are allowed, no further deposits or trading may occur.
• DecimalPlaces.OrderPrimaryCurrency - Number of decimal places accepted for order volume when denominated in primary currency
• DecimalPlaces.OrderSecondaryCurrency - Number of decimal places accepted for price denominated in secondary currency

Returns a current snapshot of the Independent Reserve market for a given currency pair.

Parameters

• primaryCurrencyCode - The cryptocurrency for which to retrieve market summary. Must be a valid primary currency, which can be checked via the GetValidPrimaryCurrencyCodes method.
• secondaryCurrencyCode - The fiat currency in which to retrieve market summary. Must be a valid secondary currency, which can be checked via the GetValidSecondaryCurrencyCodes method.

Notes

• This method caches return values for 1 second. Calling it more than once per second will result in cached data being returned.

Return value descriptions

• CreatedTimestampUtc - UTC timestamp of when the market summary was generated
• CurrentHighestBidPrice - Current highest bid on order book
• CurrentLowestOfferPrice - Current lowest offer on order book
• DayAvgPrice - Weighted average traded price over last 24 hours
• DayHighestPrice - Highest traded price over last 24 hours
• DayLowestPrice - Lowest traded price over last 24 hours
• DayVolumeXbt - Volume of primary currency traded in last 24 hours
• DayVolumeXbtInSecondaryCurrrency - Volume of primary currency traded in last 24 hours for chosen secondary currency
• LastPrice - Last traded price
• PrimaryCurrencyCode - The primary currency being summarised
• SecondaryCurrencyCode - The secondary currency being used for pricing

Returns the Order Book for a given currency pair.

Parameters

• primaryCurrencyCode - The cryptocurrency for which to retrieve order book. Must be a valid primary currency, which can be checked via the GetValidPrimaryCurrencyCodes method.
• secondaryCurrencyCode - The fiat currency in which to retrieve order book. Must be a valid secondary currency, which can be checked via the GetValidSecondaryCurrencyCodes method.
• maxDepthVolume - Limit the results to a maximum cumulated volume. This is an optional parameter.
• maxDepthValue - Limit the results to a maximum value (price * volume). This is an optional parameter.

Notes

• If both maxDepthVolume and maxDepthValue parameters are specified, the returned set is the upper limit of either one.
• This method caches return values for 1 second. Calling it more than once per second will result in cached data being returned.
• If you wish to retrieve order guids for each order, please use the GetAllOrders method.

Return value descriptions

• BuyOrders - List of all Buy Orders on order book
  • OrderType - Type of order
  • Price - Order price in secondary currency
  • Volume - Order volume in primary currency
• SellOrders - List of all Sell Orders on order book
• CreatedTimestampUtc - UTC timestamp of when the order book was generated
• PrimaryCurrencyCode - The primary currency being shown
• SecondaryCurrencyCode - The secondary currency being used for pricing

Returns the Order Book for a given currency pair including order identifiers.

Parameters

• primaryCurrencyCode - The cryptocurrency for which to retrieve order book. Must be a valid primary currency, which can be checked via the GetValidPrimaryCurrencyCodes method.
• secondaryCurrencyCode - The fiat currency in which to retrieve order book. Must be a valid secondary currency, which can be checked via the GetValidSecondaryCurrencyCodes method.
• maxDepthVolume - Limit the results to a maximum cumulated volume. This is an optional parameter.
• maxDepthValue - Limit the results to a maximum value (price * volume). This is an optional parameter.

Notes

• If both maxDepthVolume and maxDepthValue parameters are specified, the returned set is the upper limit of either one.
• This method caches return values for 1 second. Calling it more than once per second will result in cached data being returned.

Return value descriptions

• BuyOrders - List of all Buy Orders on order book
  • Guid - Unique order identifier
  • Price - Order price in secondary currency
  • Volume - Order volume in primary currency
• SellOrders - List of all Sell Orders on order book
• CreatedTimestampUtc - UTC timestamp of when the order book was generated
• PrimaryCurrencyCode - The primary currency being shown
• SecondaryCurrencyCode - The secondary currency being used for pricing

Returns summarised historical trading data for a given currency pair. Data is summarised into 1 hour intervals.

Parameters

• primaryCurrencyCode - The cryptocurrency for which to retrieve trade history. Must be a valid primary currency, which can be checked via the GetValidPrimaryCurrencyCodes method.
• secondaryCurrencyCode - The fiat currency in which to retrieve trade history. Must be a valid secondary currency, which can be checked via the GetValidSecondaryCurrencyCodes method.
• numberOfHoursInThePastToRetrieve - How many past hours of historical summary data to retrieve (maximum is 240)

Notes

• This method caches return values for 30 minutes. Calling it more than once per 30 minutes will result in cached data being returned.

Return value descriptions

• CreatedTimestampUtc - TC timestamp of when the data was generated
• HistorySummaryItems - List of hourly summary blocks
  • AverageSecondaryCurrencyPrice - Deprecated, not used
  • ClosingSecondaryCurrencyPrice - Last traded price in hour
  • StartTimestampUtc - UTC Start time of hour
  • EndTimestampUtc - UTC End time of hour
  • HighestSecondaryCurrencyPrice - Highest traded price during hour
  • LowestSecondaryCurrencyPrice - Lowest traded price during hour
  • NumberOfTrades - umber of trades executed during hour
  • OpeningSecondaryCurrencyPrice - Opening traded price at start of hour
  • PrimaryCurrencyVolume - Volume of primary currency trade during hour
  • SecondaryCurrencyVolume - Deprecated, not used
• NumberOfHoursInThePastToRetrieve - Number of past hours being returned
• PrimaryCurrencyCode - The primary currency being shown
• SecondaryCurrencyCode - The secondary currency being used for pricing

Returns a list of most recently executed trades for a given currency pair.

Parameters

• primaryCurrencyCode - The cryptocurrency for which to retrieve recent trades. Must be a valid primary currency, which can be checked via the GetValidPrimaryCurrencyCodes method.
• secondaryCurrencyCode - The fiat currency in which to retrieve recent trades. Must be a valid secondary currency, which can be checked via the GetValidSecondaryCurrencyCodes method.
• numberOfRecentTradesToRetrieve - How many recent trades to retrieve (maximum is 50)

Notes

• This method caches return values for 1 second. Calling it more than once per second will result in cached data being returned.

Return value descriptions

• CreatedTimestampUtc - TC timestamp of when the data was generated
• PrimaryCurrencyCode - The primary currency being shown
• SecondaryCurrencyCode - The secondary currency being used for pricing
• Trades - List of individual trades
  • TradeGuid - Unique identifier of the trade
  • Taker - The order side that was the taker. Possible values are Bid, Offer
  • PrimaryCurrencyAmount - Amount traded in primary currency
  • SecondaryCurrencyTradePrice - Price of trade in secondary currency
  • TradeTimestampUtc - UTC timestamp of trade

Returns a list of exchange rates used by Independent Reserve when depositing funds or withdrawing funds from accounts.

This method does not take any parameters.

Notes

• The rates represent the amount of Currency Code B that can be bought with 1 unit of Currency Code A.
• This method caches return values for 1 minute. Calling it more than once per minute will result in cached data being returned.

Returns a list of minimum allowed volumes for orders.

This method does not take any parameters.

Returns the fee schedule for fiat deposits. Crypto deposits do not incur fees.

This method does not take any parameters.

Return value descriptions

• DepositType - The method of deposit
• FreeThreshold - An amount below this threshold will incur a deposit fee. When null, the fee is always applied.
• Fee - Deposit fee which will be deducted from deposit amount when under threshold. Denominated in the deposit currency.
  • Fixed - Fixed fee amount
  • Percentage - Percentage fee

Returns the fee schedule for all withdrawals.

This method does not take any parameters.

Return value descriptions

• WithdrawalType - The withdrawal method
• MinimumAmount - The minimum withdrawal amount
• CurrencyCode - The withdrawal currency
• Fee - Withdrawal fee which will be charged from your account.
  • Fixed - Fixed fee amount
  • Percentage - Percentage fee

Returns the fee schedule for crypto withdrawals.

This method does not take any parameters.

Return value descriptions

• CurrencyCode - Withdrawal fee for the currency. Denominated in the withdrawal currency.

All private API methods require authentication. All method parameters (except signature) are required to authenticate a request. There are three additional parameters which should be passed to private API methods:

• API Key
• Nonce or Expiry
• Signature

To generate an API Key, go to the Settings page, "API Keys" and then "Generate API Key". Select the level of access. Ensure that you the lowest level of access required for your usage.

It is strongly recommended to take advantage of the IP Address restriction when creating the key. The server will reject any usage of the key from an unauthorised IP Address.

Either specify a nonce or expiry. One of these parameters must be specified, but not both. Using an expiry has the advantage of not needing to synchronise a nonce across multiple threads.

When using nonce, it should be a 64-bit unsigned integer. The nonce must increase with each request made to the API. For example, if the nonce is set to 1 in the first request, it must be set to at least 2 in the subsequent request. It is not necessary to start with 1. A common practice is to use Unix time for this parameter.

When using expiry, it should be a Unix UTC timestamp in seconds. For example 2024-03-02T01:23:45Z has Unix timestamp 1709342625. The server will reject any request with an expiry in the past or more than 30 seconds into the future. Additionally, the API key must have been restricted to at least one IP Address at the time of creation.

Whichever parameter is chosen, it must be used to form the signature.

Signature is a HMAC-SHA256 encoded message. The message is comma-separated string containing the API method URL, and a comma separated list of all method parameters (except signature) in the form: "parameterName=parameterValue". The HMAC-SHA256 code must be generated using the API Secret that was generated with your API key. This code must be converted to it's hexadecimal representation.

Notes

To avoid typical errors please ensure that in your code

• the parameter names are spelled correctly;
• the parameter values are same in signature input string and message body;
• the parameter sequence used to create the signature must match the method documentation.

Example (Python)

Private methods should be accessed via HTTP POST and require a valid authentication token to be passed. Parameters for all private methods, including the three parameters to authenticate the call, must be posted as a JSON object.

The table below lists the private API methods along with the API Role required to access the method.

The Restricted Withdrawals role can only withdraw to whitelisted addresses and bank accounts. To whitelist an address or a bank account, please first execute a withdrawal using the web portal or alternatively for cryptocurrency, add the address to the address book.

You can request via Support to restrict API key usage to a specific IP address.

Retrieves a page of a specified size with your currently Open and Partially Filled orders.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• primaryCurrencyCode - The primary currency of orders. This is an optional parameter.
• secondaryCurrencyCode - The secondary currency of orders. This is an optional parameter.
• pageIndex - Must be larger than 0.
• pageSize - Must be between 1 and 100.

Return value descriptions

• PageSize - Number of orders shown per page
• TotalItems - Total number of open orders
• TotalPages - Total number of pages
• Data - List of all open orders
  • AvgPrice - Average price for all trades executed for the order
  • CreatedTimestampUtc - UTC timestamp of when order was created
  • FeePercent - Brokerage fee
  • OrderGuid - Unique identifier of the order
  • OrderType - Type of order
  • Outstanding - Unfilled volume still outstanding on this order
  • Price - Order limit price in secondary currency
  • PrimaryCurrencyCode - Primary currency of order
  • SecondaryCurrencyCode - Secondary currency of order
  • Status - Order status (Open, PartiallyFilled)
  • Value - The value of the order, denominated in secondary currency
  • Volume - The original volume ordered
• AvgPrice - Average price for all trades executed for the order
• CreatedTimestampUtc - UTC timestamp of when order was created
• FeePercent - Brokerage fee
• OrderGuid - Unique identifier of the order
• OrderType - Type of order
• Outstanding - Unfilled volume still outstanding on this order
• Price - Order limit price in secondary currency
• PrimaryCurrencyCode - Primary currency of order
• SecondaryCurrencyCode - Secondary currency of order
• Status - Order status (Open, PartiallyFilled)
• Value - The value of the order, denominated in secondary currency
• Volume - The original volume ordered
• Original
  • Volume - The original volume ordered
  • Outstanding - Unfilled volume outstanding on this order in original currency
  • VolumeCurrencyType - Whether volume is denominated in Primary or Secondary currency

Retrieves a page of a specified size with your Closed and Cancelled orders.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• primaryCurrencyCode - The primary currency of orders. This is an optional parameter.
• secondaryCurrencyCode - The secondary currency of orders. This is an optional parameter.
• pageIndex - Must be larger than 0.
• pageSize - Must be between 1 and 5000.
• fromTimestampUtc - The timestamp in UTC, specified according to ISO 8601 standard, e.g. 2023-08-01T08:00:00Z, from which you want to retrieve orders. This is an optional parameter.
• includeTotals - Defaults to true for backward compatibility. When set to false, response time is improved and the TotalItems and TotalPages properties are returned as -1.

Notes

• Only recently cancelled orders will be returned; cancelled orders are regularly purged from history.

Return value descriptions

• PageSize - Number of orders shown per page
• TotalItems - Total number of closed orders
• TotalPages - Total number of pages
• Data - List of closed and recently cancelled orders
  • AvgPrice - Average price for all trades executed for the order
  • CreatedTimestampUtc - UTC timestamp of when order was created
  • FeePercent - Brokerage fee
  • OrderGuid - Unique identifier of the order
  • OrderType - Type of order,
  • Outstanding - Unfilled volume still outstanding on this order
  • Price - Order limit price in secondary currency
  • PrimaryCurrencyCode - Primary currency of order
  • SecondaryCurrencyCode - Secondary currency of order
  • Status - Order status (Filled, PartiallyFilledAndCancelled, Cancelled, PartiallyFilledAndExpired, Expired)
  • Value - The value of the order, denominated in secondary currency
  • Volume - The original volume ordered
  • Original
    • Volume - The original volume ordered
    • Outstanding - Unfilled volume outstanding on this order in original currency
    • VolumeCurrencyType - Whether volume is denominated in Primary or Secondary currency

Retrieves a page of a specified size with your Closed orders which have had some or all of their outstanding volume filled.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• primaryCurrencyCode - The primary currency of orders. This is an optional parameter.
• secondaryCurrencyCode - The secondary currency of orders. This is an optional parameter.
• pageIndex - Must be larger than 0.
• pageSize - Must be between 1 and 5000.
• fromTimestampUtc - The timestamp in UTC, specified according to ISO 8601 standard, e.g. 2023-08-01T08:00:00Z, from which you want to retrieve orders. This is an optional parameter.
• includeTotals - Defaults to true for backward compatibility. When set to false, response time is improved and the TotalItems and TotalPages properties are returned as -1.

Return value descriptions

• PageSize - Number of orders shown per page
• TotalItems - Total number of closed orders
• TotalPages - Total number of pages
• Data - List of closed and partially filled orders
  • AvgPrice - Average price for all trades executed for the order
  • CreatedTimestampUtc - UTC timestamp of when order was created
  • FeePercent - Brokerage fee
  • OrderGuid - Unique identifier of the order
  • OrderType - Type of order
  • Outstanding - Unfilled volume still outstanding on this order
  • Price - Order limit price in secondary currency
  • PrimaryCurrencyCode - Primary currency of order
  • SecondaryCurrencyCode - Secondary currency of order
  • Status - Order status (Filled, PartiallyFilledAndCancelled, PartiallyFilledAndExpired)
  • Value - The value of the order, denominated in secondary currency
  • Volume - The original volume ordered
  • Original
    • Volume - The original volume ordered
    • Outstanding - Unfilled volume outstanding on this order in original currency
    • VolumeCurrencyType - Whether volume is denominated in Primary or Secondary currency

Retrieves details about a single order.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• orderGuid - The guid of the order^{^}.
• clientId - The clientId that was supplied when placing an order ^{^}.

^{^} Only one of these parameters may be supplied at a time

Return value descriptions

• CreatedTimestampUtc - UTC timestamp of when order was created
• OrderGuid - Unique identifier of the order
• Type - Type of order
• VolumeOrdered - The original volume ordered
• VolumeFilled - Volume already filled on this order
• Price - Order limit price in secondary currency
• AvgPrice - Average price for all trades executed for the order
• ReservedAmount - The amount of funds reserved in your account by this order
• Status - Order status (Open, PartiallyFilled, Filled, PartiallyFilledAndCancelled, Cancelled, PartiallyFilledAndExpired, Expired)
• PrimaryCurrencyCode - Primary currency of order
• SecondaryCurrencyCode - Secondary currency of order
• VolumeCurrencyType - Whether volume is denominated in Primary or Secondary currency

Retrieves information about your Independent Reserve accounts in crypto and fiat currencies.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.

Return value descriptions

• AccountGuid - Unique identifier of account
• AccountStatus - Status of account
• AvailableBalance - Available balance in account to trade or withdraw
• CurrencyCode - Currency of account
• TotalBalance - Total balance in account

Retrieves a page of a specified size containing all transactions made on an account.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• accountGuid - The Guid of your Independent Reserve account. You can retrieve information about your accounts via the GetAccounts method.
• fromTimestampUtc - The timestamp in UTC, specified according to ISO 8601 standard, e.g. 2022-08-01T08:00:00Z, from which you want to retrieve transactions. This is an optional parameter.
• toTimestampUtc - The timestamp in UTC, specified according to ISO 8601 standard, e.g. 2022-08-07T08:00:00Z, until which you want to retrieve transactions. This is an optional parameter.
• txTypes - Array of transaction types for filtering. This is an optional parameter.
• pageIndex - Must be larger than 0.
• pageSize - Must be between 1 and 5000.
• includeTotals - Defaults to true for backward compatibility. When set to false, response time is improved and the TotalItems and TotalPages properties are returned as -1.

Notes

Array parameters should be serialized for signature input as comma-separated value list.
Example: txTypes=Brokerage,Trade

Return value descriptions

• TransactionGuid - Unique identifier of the transaction
• Balance - Running balance in account
• BitcoinTransactionId - Related Bitcoin network transaction
• BitcoinTransactionOutputIndex - Related Bitcoin network transaction output index
• EthereumTransactionId - Related Ethereum network transaction
• Comment - Comments related to transaction
• CreatedTimestampUtc - UTC created timestamp of transaction
• Credit - Credit amount
• CurrencyCode - Currency of account this transaction relates to
• Debit - Debit amount
• SettleTimestampUtc - UTC settlement timestamp
• Status - Transaction status
• Type - Transaction type
• CorrelationId - This is a context sensitive key. If the transaction is a withdrawal, it will be the primary key for the withdrawal request. When the transaction is a crypto deposit, the value will be the transaction hash from the network. In the case of a trade, the value will be the tradeGuid.

Retrieves the list of pre-configured external bank accounts.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.

Retrieves the deposit address which should be used for cryptocurrency deposits.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• primaryCurrencyCode - The cryptocurrency to generate deposit address for.

Return value descriptions

• DepositAddress - Digital address to use for deposits
• Tag - Returned for cryptocurrencies that support tags (for example: Xrp, Xlm)
• LastCheckedTimestampUtc - UTC timestamp of when this address was last checked against the blockchain
• NextUpdateTimestampUtc - UTC timestamp of when this address is scheduled to next be checked against the blockchain

Retrieves a page of cryptocurrency deposit addresses which have been assigned to your account.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• primaryCurrencyCode - The cryptocurrency to retrieve deposit addresses for.
• pageIndex - Must be larger than 0.
• pageSize - Must be between 1 and 50.

Return value descriptions

• DepositAddress - Deposit address to use for deposits
• Tag - Returned for cryptocurrencies that support tags (for example: Xrp, Xlm)
• LastCheckedTimestampUtc - UTC timestamp of when this address was last checked against the blockchain
• NextUpdateTimestampUtc - UTC timestamp of when this address is scheduled to next be checked against the blockchain

Retrieves a page of a specified size containing trades which were executed against your orders.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• pageIndex - Must be larger than 0.
• pageSize - Must be between 1 and 50.
• fromTimestampUtc - The timestamp in UTC, specified according to ISO 8601 standard, e.g. 2022-08-01T08:00:00Z, from which you want to retrieve transactions. This is an optional parameter.
• toTimestampUtc - The timestamp in UTC, specified according to ISO 8601 standard, e.g. 2022-08-07T08:00:00Z, until which you want to retrieve transactions. This is an optional parameter.

Notes

• This method caches return values for 1 second. Calling it more than once per second will result in cached data being returned.

Return value descriptions

• TradeGuid - Unique identifier of the trade
• TradeTimestampUtc - UTC timestamp corresponding to trade execution
• OrderGuid - Unique identifier of the order which was matched as part of the trade
• OrderType - The type of order which was matched
• OrderTimestampUtc - UTC timestamp when order was created
• VolumeTraded - The volume of primary currency traded
• Price - The price in secondary currency at which the trade was executed
• PrimaryCurrencyCode - The primary currency which was traded
• SecondaryCurrencyCode - The secondary currency in which the trade was denominated

Retrieves the list of trades executed against your order.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• orderGuid - Unique identifier of the order^{^}.
• pageIndex - Must be larger than 0.
• pageSize - Must be between 1 and 50.
• clientId - The clientId that was supplied when placing an order ^{^}

^{^} At least one of these parameters should be supplied

Notes

• This method caches return values for 1 second. Calling it more than once per second will result in cached data being returned.

Return value descriptions

• TradeGuid - Unique identifier of the trade
• TradeTimestampUtc - UTC timestamp corresponding to trade execution
• OrderGuid - Unique identifier of the order which was matched as part of the trade
• OrderType - The type of order which was matched
• OrderTimestampUtc - UTC timestamp when order was created
• VolumeTraded - The volume of primary currency traded
• Price - The price - denominated in the secondary currency - at which the trade was executed
• PrimaryCurrencyCode - The primary currency which was traded
• SecondaryCurrencyCode - The secondary currency in which the trade was denominated

Retrieves information about the trading fees for the cryptocurrencies in your Independent Reserve account.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.

Return value descriptions

• CurrencyCode - The currency the fee applies to
• Fee - Fee value

Get the details of a specific digital currency withdrawal

Parameters

Either transactionGuid or clientId must be specified as the key to retrieve the record.

• apiKey - Your API Key
• nonce - Nonce value
• signature - HMAC-SHA256 encoded message to authenticate API call
• transactionGuid - This should either be the TransactionGuid returned by WithdrawDigitalCurrency, or the CorrelationId returned by GetTransactions.
• clientId - If the withdrawal was created with a clientId, it can be retrieved by the same clientId

Return value descriptions

• TransactionGuid - Unique identifier of the withdrawal
• PrimaryCurrencyCode - Currency being withdrawn
• CreatedTimestampUtc - Timestamp in UTC when fiat withdrawal request was created
• Amount
  • Total - Total amount being withdrawn by the user (inclusive of any fees)
  • Fee - Fee amount which will be taken out of the withdrawal amount
• Destination
  • Address - Target cryptocurrency address
  • Tag - Target cryptocurrency destination tag.
• Status - Request status in the workflow (Pending, Held, Approved, Executing, Executed, Rejected, Cancelled)
• Transaction - Value is null if transaction hasn't been broadcasted to the network
  • Hash - Related blockchain network transaction
  • OutputIndex - The index of the transaction output to the destination address. This value is specified only for Xbt, Bch, Bsv, Ltc.

Get details on a specific fiat withdrawal. See our FAQ for more information on fiat withdrawals.

Parameters

Either fiatWithdrawalRequestGuid or clientId must be specified as the key to retrieve the record.

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• fiatWithdrawalRequestGuid - Fiat withdrawal request identifier.
• clientId - If the withdrawal was created with a clientId, it can be retrieved by the same clientId

Return value descriptions

• FiatWithdrawalRequestGuid - fiat withdrawal request identifier
• AccountGuid - IR account to withdraw from
• Status - Request status in the workflow
• CreatedTimestampUtc - Timestamp in UTC when fiat withdrawal request was created
• TotalWithdrawalAmount - Total amount being withdrawn by the user (inclusive of any fees)
• FeeAmount - Fee amount which will be taken out of the withdrawal amount
• Currency - Currency being withdrawn

Get fiat deposit limits.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.

Return value descriptions

• Fiat - Array of deposit types
  • DepositType - Method of deposit
  • MaxTransactionAmount - Maximum amount of a single payment
  • Limits
    • Deposited - Total amount of deposits processed within the period
    • Period - "Day"
    • AutomaticApprovalLimit - Deposits up to this amount in the period will be processed and credited to your account automatically. Amounts over this limit will require review by an operator.

Get withdrawal limits.

Parameters

• apiKey: Your API Key.
• nonce: Nonce value.
• signature: HMAC-SHA256 encoded message to authenticate API call.

Return value descriptions

• Xbt - Primary currency code
  • Withdrawn - Total amount of withdrawals processed within the period
  • Period - Sliding window the limit applies to. Formatted as Iso8601 duration
  • AutomaticApprovalLimit - Withdrawals up to this amount made during the period will be processed automatically

Places new limit bid / offer order. A Limit Bid is a buy order and a Limit Offer is a sell order.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• primaryCurrencyCode - The cryptocurrency code of limit order. Must be a valid primary currency, which can be checked via the GetValidPrimaryCurrencyCodes method.
• secondaryCurrencyCode - The fiat currency of limit order. Must be a valid secondary currency, which can be checked via the GetValidSecondaryCurrencyCodes method.
• orderType - The type of limit order. Must be a valid limit order type, which can be checked via the GetValidLimitOrderTypes method.
• price - The price in secondary currency to buy/sell.
• volume - The volume to buy/sell in primary currency.
• timeInForce - See details below
• clientId - Specify your own clientId to a maximum of 36 characters. Uniqueness of clientId will be enforced across orders for a guaranteed 24 hours minimum, but in most cases longer. If an order is placed with a duplicate clientId, it will be rejected. Do not insert sensitive data, the clientId is publicly visible via our websocket channels.

Time In Force

When placing limit orders, several different options are available for the timeInForce argument. If omitted, the assumed value is Gtc.

Return value descriptions

• CreatedTimestampUtc - TC timestamp of when order was created
• OrderGuid - Unique identifier of the order
• Price - Order limit price in secondary currency
• PrimaryCurrencyCode - Primary currency of order
• ReservedAmount - The amount of funds reserved in your account by this order
• SecondaryCurrencyCode - Secondary currency of order
• Status - Order status (Open, PartiallyFilled, Filled)
• Type - Type of order
• VolumeFilled - Volume already filled on this order
• VolumeOrdered - The original volume ordered
• VolumeCurrencyType - Indicate in which currency the volume is denominated

Place new market bid / offer order. A Market Bid is a buy order and a Market Offer is a sell order.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature: HMAC-SHA256 encoded message to authenticate API call.
• primaryCurrencyCode - The cryptocurrency code of market order. Must be a valid primary currency, which can be checked via the GetValidPrimaryCurrencyCodes method.
• secondaryCurrencyCode - The fiat currency of market order. Must be a valid secondary currency, which can be checked via the GetValidSecondaryCurrencyCodes method.
• orderType - The type of market order. Must be a valid market order type, which can be checked via the GetValidMarketOrderTypes method.
• volume - The volume of currency to order, denominated in volumeCurrencyType.
• volumeCurrencyType - Optional with default value of "Primary". Possible values are Primary, Secondary.
• clientId - Specify your own clientId to a maximum of 36 characters. Uniqueness of clientId will be enforced across orders for a guaranteed 24 hours minimum, but in most cases longer. If an order is placed with a duplicate clientId, it will be rejected. Do not insert sensitive data, the clientId is publicly visible via our websocket channels.
• allowedSlippagePercent - Optional parameter for slippage protection, in which the order will be rejected after the market has moved by the specified amount.

Return value descriptions

• CreatedTimestampUtc - TC timestamp of when order was created
• OrderGuid - Unique identifier of the order
• PrimaryCurrencyCode - Primary currency of order
• ReservedAmount - The amount of funds reserved in your account by this order
• SecondaryCurrencyCode - Secondary currency of order
• Status - Order status (Open, PartiallyFilled, Filled)
• Type - Type of order
• VolumeFilled - Volume already filled on this order
• VolumeOrdered - The original volume ordered
• VolumeCurrencyType - Whether volume is denominated in Primary or Secondary currency

Cancels a previously placed order.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• orderGuid - The guid of currently open or partially filled order.

Notes

• The order must be in either 'Open' or 'PartiallyFilled' status to be valid for cancellation. You can retrieve list of Open and Partially Filled orders via the GetOpenOrders method. You can also check an individual order's status by calling the GetOrderDetails method.

Return value descriptions

• AvgPrice - Average price for all trades executed for the order
• CreatedTimestampUtc - TC timestamp of when order was created
• OrderGuid - Unique identifier of the order
• Price - Order limit price in secondary currency
• PrimaryCurrencyCode - Primary currency of order
• ReservedAmount - The amount of funds reserved in your account by this order
• SecondaryCurrencyCode - Secondary currency of order
• Status - Order status (Filled, PartiallyFilledAndCancelled, Cancelled, PartiallyFilledAndExpired, Expired)
• Type - Type of order
• VolumeFilled - Volume already filled on this order
• VolumeOrdered - The original volume ordered
• VolumeCurrencyType - Whether volume is denominated in Primary or Secondary currency

Accepts an array of orderGuid so that multiple orders can be cancelled in the one call.

Response will contain cancellation result for each individual order.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• orderGuids - An array of order guids.

Notes

• The orderGuids parameter is a JSON array in the POST body but for signature generation, the orderGuids should be formatted as csv. For example orderGuids=Guid1,Guid2.
• The order must be in either 'Open' or 'PartiallyFilled' status to be valid for cancellation. You can retrieve list of Open and Partially Filled orders via the GetOpenOrders method. You can also check an individual order's status by calling the GetOrderDetails method.

Forces the deposit address to be checked for cryptocurrency deposits.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• depositAddress - The cryptocurrency deposit address to check for new deposits.
• primaryCurrencyCode - Primary currency code.

Return value descriptions

• DepositAddress - Cryptocurrency deposit address to be updated
• LastCheckedTimestampUtc - UTC timestamp of when this address was last checked against the blockchain
• NextUpdateTimestampUtc - UTC timestamp of when this address is scheduled to next be checked against the blockchain

Creates a Fiat currency withdrawal from your Independent Reserve account to an external bank account. See the fiat withdrawals FAQ for more information.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• secondaryCurrencyCode - The Independent Reserve fiat currency account to withdraw from.
• withdrawalAmount - Amount of fiat currency to withdraw.
• fiatBankAccountGuid: Fiat bank account guid
• useNpp: Send instantly using NPP
• comment - Withdrawal comment. Should not exceed 500 characters.
• clientId - Optional. Specify your own clientId to a maximum of 36 characters. Uniqueness of clientId will be enforced for a guaranteed 24 hours minimum, but in most cases longer. If a fiat withdrawal is placed with a duplicate clientId, it will be rejected.

Return value descriptions

• FiatWithdrawalRequestGuid - Unique indentifier of this request
• AccountGuid - IR account to withdraw from
• Status - Request status in the workflow
• CreatedTimestampUtc - Timestamp in UTC when fiat withdrawal request was created
• TotalWithdrawalAmount - Total amount being withdrawn by the user (inclusive of any fees)
• FeeAmount - Fee amount which will be taken out of the withdrawal amount
• Currency - Currency being withdrawn

Creates a cryptocurrency withdrawal request. There is a minimum withdrawal value for each cryptocurrency, except where the available balance is less than this amount. In all cases, the withdrawal amount must be greater than the withdrawal fee. Take care to provide a valid destination address. Cryptocurrency withdrawals are irreversible once sent.

Notes

• Only API Keys which are explicitly marked as being allowed to withdraw cryptocurrency can call this method.

Parameters

• apiKey - Your API Key.
• nonce - Nonce value.
• signature - HMAC-SHA256 encoded message to authenticate API call.
• amount - The amount of cryptocurrency to withdraw.
• withdrawalAddress - Target Bitcoin or Ether withdrawal address.
• comment - Withdrawal comment. Should not exceed 500 characters.
• primaryCurrencyCode - Primary currency code.
• destinationTag - Optional. For cryptocurrencies that support tags (for example: XRP)
• clientId - Optional. Specify your own clientId to a maximum of 36 characters. Uniqueness of clientId will be enforced for a guaranteed 24 hours minimum, but in most cases longer. If a crypto withdrawal is placed with a duplicate clientId, it will be rejected.

Return value descriptions

• TransactionGuid - Unique identifier of the withdrawal
• PrimaryCurrencyCode - Currency being withdrawn
• CreatedTimestampUtc - Timestamp in UTC when fiat withdrawal request was created
• Amount
  • Total - Total amount being withdrawn by the user (inclusive of any fees)
  • Fee - Fee amount which will be taken out of the withdrawal amount
• Destination
  • Address - Target cryptocurrency address
  • Tag - Target cryptocurrency destination tag.
• Status - Request status in the workflow (Pending, Held, Approved, Executing, Executed, Rejected, Cancelled)
• Transaction - Value is null if transaction hasn't been broadcasted to the network
  • Hash - Related blockchain network transaction
  • OutputIndex - The index of the transaction output to the destination address. This value is specified only for Xbt, Bch, Bsv, Ltc.

The API uses standard HTTP status codes 200/400 to indicate the success/failure of a request. In the event of an error, the response body will contain a JSON object with ErrorCode and Message properties like below:

The following table lists the specific error codes that the API can return. The Message property in the response may contain more context specific details. The description below is a general guide for the class of error.

Below are sample API client code libraries that can be used as a point of reference or as the basis of your own applications that integrate with Independent Reserve.

Please keep in mind that neither Independent Reserve nor the third party authors are responsible for losses due to bugs or improper use of the API. Independent Reserve have performed an initial review of the veracity of the third party code but cannot vouch for any changes made since then. If you have concerns, please contact us via the support page.

WebSockets documentation is available on our github repository.