Admin: Created page with "'''Prime API'' is based on JSON, delivered through HTTPS and is mostly REST-ful. API URIs always start with a marker "/v1" to make the version explicit. All timestamps are ret..."

2019-06-28T10:00:25Z

Created page with "'''Prime API'' is based on JSON, delivered through HTTPS and is mostly REST-ful. API URIs always start with a marker "/v1" to make the version explicit. All timestamps are ret..."

New page

'''Prime API'' is based on JSON, delivered through HTTPS and is mostly REST-ful. API URIs always start with a marker "/v1" to make the version explicit. All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

==Public API==

Public API calls are available without authentication.

==Private API==

Private API calls require authentication via:
* Your personal API key and optionally
* IP address

Private API is '''off by default'''. You need to enable it in your profile.

You are expected to '''pass the API key as a HTTP header''':
Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe
...where the long string is of course your API key.

It is also possible to pass the API key as a request param:
?api_key=84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe
...although this is not recommended as sensitive data should not be passed in the URI.

===Get my deposit address===

GET /v1/prv/deposit_address/:currency_name.json
* '''currency_name''' - obligatory cryptocurrency name, i.e BTC, LTC

Example:
<source lang="bash">
curl -v --request GET http://localhost:3000/v1/prv/deposit_address/BTC.json --header "Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe"
</source>

Response:
200 OK
<source lang="javascript">
{"address":"n2Ccn5em9gcQyBe2QvZnfzzXq8EZh1ncJj"}
</source>

Error response:
422 Unprocessable Entity
<source lang="javascript">
{"errors":{"currency_name":"is invalid"}}
</source>

===Get balances and user data===

GET /v1/prv/user.json

Example:
<source lang="bash">
curl -i --request GET http://localhost:3000/v1/prv/user.json --header "Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe"
</source>

Response:
200 OK
<source lang="javascript">
{
"user": {
"username": "adalovelace",
"email": "adalovelace@bitcoinfoundation.org",
"balances": [
{
"available": "0.199",
"total": "0.199",
"currency_name": "BTC"
},
{
"available": "0.0",
"total": "0.0",
"currency_name": "PLN"
},
{
"available": "7.11",
"total": "7.11",
"currency_name": "LTC"
}
]
}
}
</source>
* '''available''' - the amount you can manage, i.e. to place a new offer
* '''total''' - the amount including funds reserved for offers, withdrawals, etc.

===Create a withdrawal request (of cryptocurrency)===

POST /v1/prv/withdrawal_request.json
* '''currency_name''' - obligatory name of the currency like BTC, LTC, PLN
* '''address''' - obligatory only for cryptocurrencies
* '''amount''' - obligatory
* '''otp''' - obligatory when user has set up a Google Authenticator One-Time-Passwords for withdrawals

Example:
<source lang="bash">
curl -i --request POST http://localhost:3000/v1/prv/withdrawal_requests.json --header "Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRM6sLRdM" \
--data "currency_name=BTC&address=mm2SjeJ64vQokDjnkhvhcv9mGk1VfEJRsk&amount=0.03"
</source>

Response:
201 Created

Error response (missing or invalid OTP):
401 Unauthorized
<source lang="javascript">
{
"errors": {
"otp": "is invalid"
}
}
</source>

Error response (invalid params):
422 Unprocessable Entity
<source lang="javascript">
{
"errors": {
"currency_name": "is invalid",
"address": "is_invalid",
"amount": "is invalid"
}
}
</source>

==Source==

[http://bitcoin.it/ http://bitcoin.it/]

[[Category:Technology]]
==See Also on BitcoinWiki==
* [[Tawarruq Token]]
* [[Little Phil]]
* [[Coal Coin]]
* [[Crypt-ON]]
* [[Daox]]

Prime API - Revision history

Admin: Created page with "'''Prime API'' is based on JSON, delivered through HTTPS and is mostly REST-ful. API URIs always start with a marker "/v1" to make the version explicit. All timestamps are ret..."