Skip to content

Commit 315854a

Browse files
committed
Updating README to include links to docs, grouping methods, and new info
1 parent 24e6e3e commit 315854a

File tree

1 file changed

+33
-20
lines changed

1 file changed

+33
-20
lines changed

README.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -75,28 +75,41 @@ bybit_p2p library currently consists of just one module, which is used for direc
7575
You can access P2P API documentation using this link: [Not Available at this moment in time](https://google.com/)
7676

7777
Here is a breakdown of how API methods correspond to appropriate bybit_p2p methods:
78+
79+
Advertisements:
80+
| bybit_p2p method name | P2P API method name | P2P API endpoint path |
81+
| --- | --- | --- |
82+
| get_online_ads() | Get Market Online Ads list | [/v5/p2p/item/online](https://bybit-exchange.github.io/docs/p2p/ad/online-ad-list) |
83+
| post_new_ad() | Post New Ad | [/v5/p2p/item/create](https://bybit-exchange.github.io/docs/p2p/ad/post-new-ad) |
84+
| remove_ad() | Remove ad | [/v5/p2p/item/cancel](https://bybit-exchange.github.io/docs/p2p/ad/remove-ad) |
85+
| update_ad() | Update / Relist My Ad | [/v5/p2p/item/update](https://bybit-exchange.github.io/docs/p2p/ad/update-list-ad) |
86+
| get_ads_list() | Get ads list | [/v5/p2p/item/personal/list](https://bybit-exchange.github.io/docs/p2p/ad/ad-list) |
87+
| get_ad_details() | Get ad detail | [/v5/p2p/item/info](https://bybit-exchange.github.io/docs/p2p/ad/ad-detail) |
88+
89+
Orders:
7890
| bybit_p2p method name | P2P API method name | P2P API endpoint path |
7991
| --- | --- | --- |
80-
| get_current_balance() | Get current balance | [/v5/asset/transfer/query-account-coins-balance](https://bybit-exchange.github.io/docs/v5/asset/balance/all-balance) |
81-
| get_account_information() | Get account information | /v5/p2p/user/personal/info |
82-
| get_ads_list() | Get ads list | /v5/p2p/item/personal/list |
83-
| get_ad_detail() | Get ad detail | /v5/p2p/item/info |
84-
| update_ad() | Update/reOnline ads | /v5/p2p/item/update |
85-
| offline_ad() | Offline ads | /v5/p2p/item/cancel |
86-
| get_orders() | Get orders | /v5/p2p/order/simplifyList |
87-
| get_pending_orders() | Get pending orders | /v5/p2p/order/pending/simplifyList |
88-
| get_user_order_statistics() | Get user's order statistic | /v5/p2p/user/order/personal/info |
89-
| get_order_details() | Get order detail | /v5/p2p/order/info |
90-
| release_assets() | Release digital asset | /v5/p2p/order/finish |
91-
| mark_as_paid() | Mark order as paid | /v5/p2p/order/pay |
92-
| get_chat_messages() | Get chat message | /v5/p2p/order/message/list |
93-
| upload_chat_file() | Upload chat file | /v5/p2p/oss/upload_file |
94-
| send_chat_message() | Send chat message | /v5/p2p/order/message/send |
95-
| post_new_ad() | post new ad | /v5/p2p/item/create |
96-
| get_online_ads() | online Ad list | /v5/p2p/item/online |
97-
| get_user_payment_types() | Get user payment | /v5/p2p/user/payment/list |
98-
99-
More modules will come soon, allowing for more advanced operations.
92+
| get_orders() | Get All Orders | [/v5/p2p/order/simplifyList](https://bybit-exchange.github.io/docs/p2p/order/order-list) |
93+
| get_order_details() | Get Order Details | [/v5/p2p/order/info](https://bybit-exchange.github.io/docs/p2p/order/order-detail) |
94+
| get_pending_orders() | Get Pending Orders | [/v5/p2p/order/pending/simplifyList](https://bybit-exchange.github.io/docs/p2p/order/pending-order) |
95+
| mark_as_paid() | Mark Order As Paid | [/v5/p2p/order/pay](https://bybit-exchange.github.io/docs/p2p/order/mark-order-as-paid) |
96+
| release_assets() | Release Digital Asset | [/v5/p2p/order/finish](https://bybit-exchange.github.io/docs/p2p/order/release-digital-asset) |
97+
| send_chat_message() | Send chat message | [/v5/p2p/order/message/send](https://bybit-exchange.github.io/docs/p2p/order/send-chat-msg) |
98+
| upload_chat_file() | Upload chat file | [/v5/p2p/oss/upload_file](https://bybit-exchange.github.io/docs/p2p/order/upload-chat-file) |
99+
| get_chat_messages() | Get Chat Message | [/v5/p2p/order/message/listpage](https://bybit-exchange.github.io/docs/p2p/order/chat-msg) |
100+
101+
102+
User:
103+
| get_account_information() | Get Account Information | [/v5/p2p/user/personal/info](https://bybit-exchange.github.io/docs/p2p/user/acct-info) |
104+
| get_counterparty_info() | Get Counterparty User Info | [/v5/p2p/user/order/personal/info](https://bybit-exchange.github.io/docs/p2p/user/counterparty-user-info) |
105+
| get_user_payment_types() | Get User Payment | [/v5/p2p/user/payment/list](https://bybit-exchange.github.io/docs/p2p/user/user-payment) |
106+
107+
Misc:
108+
| bybit_p2p method name | P2P API method name | P2P API endpoint path |
109+
| --- | --- | --- |
110+
| get_current_balance() | Get Coin Balance | [/v5/asset/transfer/query-account-coins-balance](https://bybit-exchange.github.io/docs/p2p/all-balance) |
111+
112+
More methods will come soon, allowing for more advanced operations.
100113

101114
## Development
102115

0 commit comments

Comments
 (0)