Starting v2.4

openware · Nov 16, 2019 · c4d3073 · c4d3073
1 parent 6d9534e
commit c4d3073
Show file tree

Hide file tree

Showing 7 changed files with 465 additions and 34 deletions.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.3.44
+2.4.0
diff --git a/docs/api/peatio_admin_api_v2.md b/docs/api/peatio_admin_api_v2.md
@@ -746,7 +746,7 @@ Get all withdraws, result is paginated.
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ---- |
-| state | query | The withdrawal state. | No | string |
+| state | formData | The withdrawal state. | No | [ string ] |
 | account | query | The account code. | No | integer |
 | id | query | The withdrawal id. | No | integer |
 | txid | query | The withdrawal transaction id. | No | string |
@@ -934,6 +934,56 @@ Returns liabilities as a paginated collection.
 | ---- | ----------- | ------ |
 | 200 | Returns liabilities as a paginated collection. | [Operation](#operation) |
 
+### /members/{uid}
+
+#### PUT
+##### Description:
+
+Set user group.
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | path | The shared user ID. | Yes | string |
+| group | formData | User gruop | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Set user group. | [Member](#member) |
+
+#### GET
+##### Description:
+
+Get a member.
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | path | The shared user ID. | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Get a member. | [Member](#member) |
+
+### /members/groups
+
+#### GET
+##### Description:
+
+Get available members groups.
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Get available members groups. |
+
 ### /members
 
 #### GET
@@ -947,6 +997,7 @@ Get all members, result is paginated.
 | ---- | ---------- | ----------- | -------- | ---- |
 | state | query | Filter order by state. | No | string |
 | role | query |  | No | string |
+| group | query |  | No | string |
 | email | query | Member email. | No | string |
 | uid | query | Member UID. | No | string |
 | range | query | Date range picker, defaults to 'created'. | No | string |
@@ -1158,12 +1209,12 @@ Get list of currencies
 | withdraw_limit_72h | string | Currency 72h withdraw limit | No |
 | base_factor | integer | Currency base factor. | No |
 | precision | integer | Currency precision. | No |
+| position | integer | Currency position. | No |
 | icon_url | string | Currency icon | No |
 | min_confirmations | string | Number of confirmations required for confirming deposit or withdrawal | No |
 | code | string | Unique currency code. | No |
 | blockchain_key | string | Associated blockchain key which will perform transactions synchronization for currency. | No |
 | min_collection_amount | double | Minimal collection amount. | No |
-| position | integer | Currency position. | No |
 | visible | string | Currency display status (true/false). | No |
 | subunits | integer | Fraction of the basic monetary unit. | No |
 | options | json | Currency options. | No |
@@ -1224,14 +1275,14 @@ Get all deposits, result is paginated.
 | state | string | Deposit state. | No |
 | created_at | string | The datetime when deposit was created. | No |
 | completed_at | string | The datetime when deposit was completed. | No |
+| tid | string | Deposit tid. | No |
 | member | string | The member id. | No |
 | uid | string | Deposit member uid. | No |
 | email | string | The deposit member email. | No |
 | address | string | Deposit blockchain address. | No |
 | txout | integer | Deposit blockchain transaction output. | No |
 | block_number | integer | Deposit blockchain block number. | No |
 | type | string | Deposit type (fiat or coin). | No |
-| tid | string | Deposit tid. | No |
 | spread | string | Deposit collection spread. | No |
 | updated_at | string | The datetime when deposit was updated. | No |
 
@@ -1312,6 +1363,7 @@ Get all members, result is paginated.
 | id | integer | Unique member identifier in database. | No |
 | level | integer | Member's level. | No |
 | role | string | Member's role. | No |
+| group | string | Member's group. | No |
 | state | string | Member's state. | No |
 | created_at | string | Member created time in iso8601 format. | No |
 | updated_at | string | Member updated time in iso8601 format. | No |

diff --git a/docs/api/peatio_management_api_v2.md b/docs/api/peatio_management_api_v2.md
@@ -160,6 +160,7 @@ Creates new withdraw. The behaviours for fiat and crypto withdraws are different
 | beneficiary_id | formData | ID of Active Beneficiary belonging to user. | No | string |
 | currency | formData | The currency code. | Yes | string |
 | amount | formData | The amount to withdraw. | Yes | double |
+| note | formData | The note for withdraw. | No | string |
 | action | formData | The action to perform. | No | string |
 
 ##### Responses
@@ -618,6 +619,7 @@ Returns withdraws as paginated collection.
 | tid | integer | The shared transaction ID. | No |
 | uid | string | The shared user ID. | No |
 | currency | string | The currency code. | No |
+| note | string | The note for withdraw. | No |
 | type | string | The withdraw type (fiat or coin). | No |
 | amount | string | The withdraw amount excluding fee. | No |
 | fee | string | The exchange fee. | No |
@@ -682,14 +684,14 @@ Returns currency by code.
 | withdraw_limit_72h | string | Currency 72h withdraw limit | No |
 | base_factor | string | Currency base factor | No |
 | precision | string | Currency precision | No |
+| position | integer | Currency position. | No |
 | icon_url | string | Currency icon | No |
 | min_confirmations | string | Number of confirmations required for confirming deposit or withdrawal | No |
 | code | string | Unique currency code. | No |
 | min_collection_amount | string | Minimal deposit amount that will be collected | No |
 | visible | string | Currency display possibility status (true/false). | No |
 | subunits | integer | Fraction of the basic monetary unit. | No |
 | options | json | Currency options. | No |
-| position | integer | Currency position. | No |
 | created_at | string | Currency created time in iso8601 format. | No |
 | updated_at | string | Currency updated time in iso8601 format. | No |
 

diff --git a/docs/api/peatio_user_api_v2.md b/docs/api/peatio_user_api_v2.md
@@ -233,6 +233,13 @@ Get the order book of specified market.
 
 Get all available markets.
 
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
+| page | query | Specify the page of paginated results. | No | integer |
+
 ##### Responses
 
 | Code | Description | Schema |
@@ -250,6 +257,8 @@ Get list of currencies
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ---- |
+| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
+| page | query | Specify the page of paginated results. | No | integer |
 | type | query | Currency type | No | string |
 
 ##### Responses
@@ -277,6 +286,30 @@ Get a currency
 | ---- | ----------- | ------ |
 | 200 | Get a currency | [Currency](#currency) |
 
+### /account/transactions
+
+#### GET
+##### Description:
+
+Get your transactions history.
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| currency | query | Currency code | No | string |
+| order_by | query | Sorting order | No | string |
+| time_from | query | An integer represents the seconds elapsed since Unix epoch. | No | integer |
+| time_to | query | An integer represents the seconds elapsed since Unix epoch. | No | integer |
+| limit | query | Limit the number of returned transactions. Default to 100. | No | integer |
+| page | query | Specify the page of paginated results. | No | integer |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Get your transactions history. |
+
 ### /account/withdraws
 
 #### POST
@@ -502,6 +535,13 @@ Get user account by currency
 
 Get list of user accounts
 
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
+| page | query | Specify the page of paginated results. | No | integer |
+
 ##### Responses
 
 | Code | Description | Schema |
@@ -765,6 +805,7 @@ Get a currency
 | withdraw_limit_72h | string | Currency 72h withdraw limit | No |
 | base_factor | string | Currency base factor | No |
 | precision | string | Currency precision | No |
+| position | string | Position used for defining currencies order | No |
 | icon_url | string | Currency icon | No |
 | min_confirmations | string | Number of confirmations required for confirming deposit or withdrawal | No |
 
@@ -816,6 +857,7 @@ Get your deposits history.
 | state | string | Deposit state. | No |
 | created_at | string | The datetime when deposit was created. | No |
 | completed_at | string | The datetime when deposit was completed.. | No |
+| tid | string | The shared transaction ID | No |
 
 #### Account
 
@@ -827,6 +869,21 @@ Get list of user accounts
 | balance | double | Account balance. | No |
 | locked | double | Account locked funds. | No |
 
+#### Transactions
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| address | string | Recipient address of transaction. | No |
+| currency | string | Transaction currency id. | No |
+| amount | double | Transaction amount. | No |
+| fee | double | Transaction fee. | No |
+| txid | string | Transaction id. | No |
+| state | string | Transaction state. | No |
+| note | string | Withdraw note. | No |
+| confirmations | integer | Number of confirmations. | No |
+| updated_at | string | Transaction updated time in iso8601 format. | No |
+| type | string | Type of transaction | No |
+
 #### Member
 
 | Name | Type | Description | Required |