This subscription feed publishes account deposits and withdrawals
Authentication is required.
|
Feed |
Event Type |
API Keys | Original & Signed Challenge |
| deposits_withdrawals |
subscribe / unsubscribe
|
Any | Yes |
| Sample Sent Message |
| { "event":"subscribe", "feed":"deposits_withdrawals", "api_key":"CMl2SeSn09Tz+2tWuzPiPUjaXEQRGq6qv5UaexXuQ3SnahDQU/gO3aT+", "original_challenge":"226aee50-88fc-4618-a42a-34f7709570b2", "signed_challenge":"RE0DVOc7vS6pzcEjGWd/WJRRBWb54RkyvV+AZQSRl4+rap8Rlk64diR+ Z9DQILm7qxncswMmJyvP/2vgzqqh+g==" } |
|
Sample Return if Successful. |
|
{ |
|
Field |
Type | Description |
|
event
|
string | The result, subscribed or subscribed_failed or unsubscribed or unsubscribed_failed |
| feed | string | The requested subscription feed |
| api_key | string | The user api key |
| original_challenge | string | The message that is received from a challenge request |
| signed_challenge | string | The signed challenge message with user api secret |
| Sample Subscription Data |
| { "feed":"deposits_withdrawals", "elements":[ { "uid":"e3835c60-2431-46d8-82b2-ad34df27d9c8", "time":"2015-02-10T09:11:05.000Z", "amount":2.5, "unit":"XBT", "receiving_address":"1DPwBCt4SpPGeLQ7YkE7evFVwmHL2bmSB8", "status":"processed", "confirmations":6, "tx_reference":"f2028fc4d5677831decabff28486eea7f9cef4773242f176481f6 634adee3b8a" }, { "uid":"4f4cd1a8-a809-46b3-9618-1cf4075f2c45", "time":"2015-02-13T07:23:19.000Z", "amount":0.0999, "unit":"XBT", "receiving_address":"1AKT7WgRU4mLDTH2fZ62C7xfXR43EybE43", "status":"processed", "confirmations":6, "tx_reference":"a0d4a655c200834de1e29a06af3c39b8ebc536229a98085ad 699454fc5314d05" }, … ] } |
|
Field |
Type | Description |
| feed | string | The subscribed feed |
| elements | list of structures | A list containing the deposit and withdrawal element |
| uid | string | The unique identifier of the log |
| time | ISO8601 datetime | The server date and time |
| amount | positive float | The amount of the deposit or withdrawal |
| unit | string | The unit of the amount |
| receiving_address | string | The receiving address of the amount |
| status | string | The status of the deposit or withdrawal |
| confirmations | positive integer | The number of the confirmations |
| tx_reference | string | The tax reference of the deposit or withdrawal |
| Sample Return if Unsuccessful |
| { "event":"error", "message":"Invalid product id" } |
|
Field |
Type | Description |
| event | string | Always error |
| message | string |
An error message out of:
|