Application Programming Interface

Table of contents

1. Version
2. How it works?
3. Errors
4. Service conditions algorithm
5. API wallet
   • Available cryptocurrencies for wallets
   • Wallets
   • Create a wallet
   • Update or rename a wallet
   • Delete a wallet
   • Get current balance
   • Get a list of unconfirmed incoming transactions
   • Get a list of withdrawal requests
   • Operations history
   • Get all entries in history
   • Get all wallet addresses
   • Get overall number of wallet addresses
   • Create a withdrawal request
   • Check the status of the withdrawal request
6. Online payment API
   • Create a one-time payment
   • Control of a one-time incoming payment
7. API of P2P Exchange
   • All advertising
   • New advertising
   • Update of advertising
   • Deletion of advertising
   • All deals
   • Deals chat
   • Chat messaging
   • Update a state of deal
   • Get a dictionary

Version

The outdated version of the API 1.0 has been replaced by the newer version 1.1

To get access, you will need to enter your email address here .

How it works?

API methods:

• invoked using the HTTP POST method
• must be authorized through the API key (you can find it in the "Settings" section of your wallet), which is displayed as the value of the required string parameter api_key
• apply JSON for request and response ('Accept' and 'Content-Type' headers must be 'application / json')

For example, the amounts for Bitcoins are represented in Satoshi: 100,000,000 Satoshi = 1 BTC or 1 Satoshi = 0.00000001 BTC.

When you deposit to the addresses generated via the API (by using the command /wallets/new or /payment), a service fee is charged. Its amount is proportional to miners’ fee and its size can be received using the command /conditions.

Errors

Any command as a response can return a list of errors that occurred during execution. Most often these are input validation errors. You will see an object with the "errors" parameter containing a list of parameters associated with this error. All parameters, in turn, contain an enumeration of string errors.

Example of an error in JSON format:

It is guaranteed that no other returned response contains an object with the 'errors' parameter.

Service conditions algorithm

URL

http://rahakott.net/api/v1.1/conditions

Parameters of request

None.

Response

As a response, we receive an array of cryptocurrencies containing the following parameters:

• service_internal_fee (number) - commission for transfers between Rahakott accounts
• service_fee (number) - commission for transfers to external wallets
• min_fee (number) - network fee (minimum)
• min_amount (number) - transfer amount (minimum)
• min_confirms (number) - the required number of confirmations for crediting money to the account (minimum)
• api_deposit_fee (number) - fee for transferring to the API address Example of request and response

Request and response example

API wallet

Available cryptocurrencies for wallets

URL

http://rahakott.net/api/v1.1/currencies

Request parameters

None.

Response

As a response, we receive the list of available cryptocurrencies.

Example of request and response

Wallets

URL

http://rahakott.net/api/v1.1/wallets

Parameters of request

• currency (string, required) - wallets currency

Response

As a response, we receive objects with a description of such wallet parameters:

• oid (string) - unique wallet identifier
• currency (string) - wallet currency
• name (string) - wallet name; in case null is specified, this is the default wallet (main wallet)
• current_address (string) - current wallet address
• created_at (date) - date of wallet creation
• updated_at (date) - date of wallet update (currently the update is associated with renaming the wallet)

Request and response example

Create a wallet

URL

http://rahakott.net/api/v1.1/wallets/new

Restrictions

• The maximum number of new wallets is 60 per hour.
• This command creates wallets that, if the balance is zero, will be automatically deleted after 14 days. To prevent the wallet from being deleted automatically, it is better to create it manually.

Request parameters

• name (string, required) - wallet name, it must be unique within the account
• currency (string, required) - wallet currency

Response

As a response, we get an object with the following parameters of the created wallet:

• oid (string) - unique wallet identifier
• currency (string) - wallet currency
• name (string) - wallet name; in case null is specified, this is the default wallet (main wallet)
• current_address (string) - current wallet address
• created_at (date) - date of wallet creation
• updated_at (date) - date of wallet update (currently the update is associated with renaming the wallet)

Request and response example

Update or rename a wallet

URL

http://rahakott.net/api/v1.1/wallets/update

Parameters of request

• oid (string, required) - wallet ID obtained through the list of wallets or creating new requests
• name (string, required) - unique wallet name within the account

Response

As a response, we get an object with the following parameters of the created wallet:

• oid (string) - unique wallet identifier
• currency (string) - wallet currency
• name (string) - wallet name; in case null is specified, this is the default wallet (main wallet)
• current_address (string) - current wallet address
• created_at (date) - date of wallet creation
• updated_at (date) - date of wallet update (currently the update is associated with renaming the wallet)

Request and response example

Delete a wallet

URL

http://rahakott.net/api/v1.1/wallets/delete

Parameters of request

• oid (string, required) - wallet ID obtained through the list of wallets or creating new requests

Response

As an answer, we get the following parameters:

• wallet_oid (string) - unique wallet identifier
• deleted (boolean) - boolean, always equal to true

Example of request and response

Get current balance

URL

http://rahakott.net/api/v1.1/wallets/balance

Parameters of request

• oid (string, required) - wallet ID obtained through the list of wallets or creating new requests

Response

As an answer, we get the following parameters:

• wallet_oid (string) - Wallet ID
• confirmed (number) - confirmed cash balance
• unconfirmed (number) - unconfirmed incoming transactions

Request and response example

Get a list of unconfirmed incoming transactions

URL

http://rahakott.net/api/v1.1/transactions/incoming

Parameters of request

• wallet (string, required) - wallet ID

Response

In response, we receive the wallet identifier and the corresponding array of objects that have the following transaction parameters:

• txid (string) - transaction ID
• amount (number) - transfer amount
• confirmations (number) - the number of transfers confirmations
• created_at (date) - date of the transfer receipt
• updated_at (date) - transfer update date (last update of the transaction number confirmation)
• address (string) - transfer address

Request and response example

Receiving a list of pending outgoing transactions (withdrawal requests)

URL

http://rahakott.net/api/v1.1/transactions/outgoing

Request parameters

• wallet (string, required) - unique wallet identifier

Response

The wallet identifier and connected with it array of objects are sent as a response. The objects have the following transaction parameters:

• request (string) - unique identifier of the withdrawal request
• address (string) - recipient's address
• amount (number) - amount of transferred funds
• external_only (boolean) - boolean signifying using external transfer (via the blockchain) for funds sending
• subtract_fees (boolean) - boolean signifying subtracting all fees from the transfer amount (is usually used for the withdrawal of all funds from the account)
• strong_mixing (boolean, optional) - boolean signifying using strong mixing
• executed (boolean) - if true, the request is completed; if false, the request is waiting to be executed; on completion, the parameter 'error' should be checked
• error (string) - if not null, an error occurred during the request execution
• created_at (date) - date of request creation for the withdrawal
• updated_at (date) - date of request update

Request and response example

Operations history

URL

http://rahakott.net/api/v1.1/history

Parameters of request

• wallet (string, required) - unique wallet identifier
• offset (number, optional) - offset from the beginning of entries, similar to OFFSET parameter in SQL-request
• limit (number, optional) - maximum number of entries in output, similar to LIMIT parameter in SQL-request

Attention! With an unspecified limit of the parameter, its value is 50.

Response

In response, we receive the wallet identifier and the corresponding array of objects that have the following historic entry parameters:

• txid (string) - ID of the transaction associated with the record
• request_id (string) - unique identifier of the request for the withdrawal according to which this entry in history was created; in case of receiving funds entry, this parameter value equals null
• address (string) - the address of one of the transaction's parties
• amount (number) - the amount of money transferred after the commission has been paid
• service_fee (number) - transaction fee
• failed (boolean) - indicates success of the operation
• created_at (date) - date of entry

Request and response example

Receiving overall number of entries in history

URL

http://rahakott.net/api/v1.1/history/count

Request parameters

• wallet (string, required) - unique wallet identifier

Response

The following parameters are sent as a response:

• wallet (string) - unique wallet identifier
• history_count (number) - number of entries in history

Request and response example

Get all wallet addresses

URL

http://rahakott.net/api/v1.1/addresses

Parameters of request

• wallet (string, required) - wallet ID
• offset (number, optional) - offset from the start of the record, identical to the OFFSET parameter in the SQL query
• limit (number, optional) - the maximum number of records in the output, identical to the LIMIT parameter in the SQL query

Attention! With an unspecified limit of the parameter, its value is 50.

Response

In response, we receive the wallet ID and the associated array of objects with the following address parameters:

• address (string) - unique wallet address
• current (boolean) - a boolean value to indicate the wallet address (there can be only one)
• created_at (date) - when the address was created

Request and response example

Get overall number of wallet addresses

URL

http://rahakott.net/api/v1.1/addresses/count

Parameters of request

• wallet (string, required) - wallet ID

Response

As a response, we get the following parameters:

• wallet (string) - wallet ID
• addresses_count (number) - total number of wallet addresses

Example of request and response

Create a withdrawal request

URL

http://rahakott.net/api/v1.1/send

Parameters of request

• wallet (string, required) - wallet ID
• recipient (string, required) - address of the recipient
• amount (number, required) - the amount of money to be transferred
• external_only (boolean, optional) - boolean value to indicate external transfer (via blockchain), default false
• subtract_fees (boolean, optional) - boolean value to denote subtract all commissions from the transfer amount (mainly when all funds are withdrawn from the account), by default false
• payment_id (string, optional, XMR only) – payment ID
• maximize_limit (boolean, optional, ETH only) – boolean value to indicate a higher gas limit
• strong_mixing (boolean, optional) - boolean with strong mixing

Response

As a response, we get the following parameters:

• wallet (string) - wallet ID
• request (string) - ID of the withdrawal request, sometimes used to check status

Example of request and response

Checking request status for money withdrawal

URL

http://rahakott.net/api/v1.1/send/check

Request parameters

• wallet (string, required) - unique wallet identifier
• request (string, required) - unique request identifier for the withdrawal

Response

An object with the description of the following request parameters is sent:

• request (string) - unique identifier of the withdrawal request
• address (string) - recipient's address
• amount (number) - amount of transferred funds
• external_only (boolean) - boolean signifying using external transfer (via the blockchain) for money sending
• subtract_fees (boolean) - boolean signifying subtracting all fees from the transfer amount (is usually used for the withdrawal of all funds from the account)
• strong_mixing (boolean) - boolean signifying using strong mixing
• maximize_limit (boolean, ETH only) – boolean signifying using higher gas limit
• executed (boolean) - if true, then the request has been executed; if false, the request is waiting for execution; on completion, the parameter 'error' should be checked
• error (string) - if not null, then an error occurred during request execution
• created_at (date) - date of withdrawal request creation
• updated_at (date) - date of request update

Request and response example

Online payment API

Create a one-time payment

URL

http://rahakott.net/api/v1.1/payment

Limitation

Maximum number of new addresses for one-time payment: 90 per hour.

Parameters of request

• wallet (string, required) - wallet ID (except for XMR and ETH)
• lifetime (number, required) - the lifetime of the transaction in days (up to 14)

Response

As a response, we receive an object with a description of the following request parameters:

• payment (string) - payment ID
• address (string) - address for incoming payment

Example of request and response

Checking the status of one-time incoming payment

URL

http://rahakott.net/api/v1.1/payment/check

Request parameters

• payment (string, required) - unique payment identifier

Response

The object with the description of the following request parameters is returned as a response:

• payment (string) - unique payment identifier
• address (string) - address for an incoming payment
• confirmed (number) - the sum of all confirmed incoming transactions to the payment address
• unconfirmed (number) - the sum of all unconfirmed incoming transactions to the payment address

Request and response example

API of P2P Exchange

All advertising

URL

http://rahakott.net/api/v1.1/market/offers

Parameters of request

• mode (string, required) - exchange direction (variants of values "buy" or "sell")
• amount (number, optional) - amount in fiat for ad limit filtering
• currency_base (string, optional) - cryptocurrency
• currency_rate (string, optional) - fiat currency
• region (number, optional) - region code, see the command /market/dictionary
• method (number, optional) - payment method code, see the command /market/dictionary
• own (boolean, optional) - boolean of requesting only your own advertisements

Response

The array of objects with the description of the following parameters of advertisements is returned as a response:

• oid (string) - unique advertisement identifier
• created_at (date) - date of the advertisement creation
• updated_at (date) - date of the advertisement update
• mode (string) - exchange direction (values "buy" or "sell")
• region (number) - region code, see the command /market/dictionary
• method (number) - payment method code, see the command /market/dictionary
• currency_base (string) - cryptocurrency
• currency_rate (string) - fiat currency
• title (string) - advertisement title
• username (string) - username of the advertisement owner
• market_price (number) - advertisement price
• limit_min (number) - minimum deal amount of the advertisement
• limit_max (number) - maximum deal amount of the advertisement
• terms (string) - terms of trade
• margin (number) - margin (only for your own advertisements)
• equation (number or string) - fixed price or exchange name (only for your own advertisements)
• open_*_start, open_*_end (числа) - beginning and end of trade time in minutes from the day start (only for your own advertisements)
• track_liquidity (boolean) - boolean of tracking limits when opening deals (only for your own advertisements)

Request and response example

New advertising

URL

http://rahakott.net/api/v1.1/market/offers/add

Parameters of request

• mode (string, required) - exchange direction
• region (number, required) - region code, see the command /market/dictionary
• method (number, required) - payment method code, see the command /market/dictionary
• currency_base (string, required) - cryptocurrency
• currency_rate (string, required) - fiat currency
• title (string, required) - advertisement title
• terms (string, required) - terms of trade
• margin (number, required) - margin (only for your own advertisements)
• equation (string, required) - fixed price or exchange name (only for your own advertisements)
• limit_min (number, optional) - minimum trade amount
• limit_max (number, optional) - maximum trade amount
• open_*_start, open_*_end (numbers, optional) - beginning and end of trade time in minutes from the day start (only for your own advertisements)
• track_liquidity (boolean, optional) - boolean of tracking limits when opening deals (only for your own advertisements)

Response

The object with the description of the advertisement parameters specified in the command /market/offers is returned as a response.

Request example

Advertisement update

URL

http://rahakott.net/api/v1.1/market/offers/update

Request parameters

• oid (string, required) - unique advertisement identifier
• mode (string, optional) - exchange direction (values "buy" or "sell")
• region (number, optional) - region code, see the command /market/dictionary
• method (number, optional) - payment method code, see the command /market/dictionary
• currency_base (string, optional) - cryptocurrency
• currency_rate (string, optional) - fiat currency
• title (string, optional) - advertisement title
• terms (string, optional) - terms of trade
• margin (number, optional) - margin (only for your own advertisements)
• equation (string, optional) - fixed price or exchange name (only for your own advertisements)
• limit_min (number, optional) - minimum deal amount of the advertisement
• limit_max (number, optional) - maximum deal amount of the advertisement
• open_*_start, open_*_end (numbers, optional) - beginning and end of trade time in minutes from the day start (only for your own advertisements)
• track_liquidity (boolean, optional) - boolean of tracking limits when opening deals (only for your own advertisements)

Response

The object with the description of the advertisement parameters specified in the command /market/offers is returned as a response.

Request example

Deletion of advertising

URL

http://rahakott.net/api/v1.1/market/offers/delete

Parameters of request

• oid (string, required) - unique advertisement identifier

Response

As a response, we get the oid field and the boolean value of a successful deletion.

Example of request and response

1. <<< POST http://rahakott.net/api/v1.1/market/offers/update
2. {"api_key":"1234567890abcdef1234567890abcdef","oid":"1234567890abcdef1234567890abcdef"}
4. >>>
5. {"oid": "1234567890abcdef1234567890abcdef","deleted":true}