Hướng dẫn sử dụng API Python của Backpack Exchange

Điều Kiện Tiên Quyết

Lấy API keys của bạn nếu bạn sẽ sử dụng các account endpoints: https://backpack.exchange/portfolio/settings/api-keysarrow-up-right

Cài đặt các thư viện Python cần thiết:

  • cryptography - dùng cho X-Signature (chỉ dành cho account endpointsarrow-up-right)

  • requests - dùng để thực hiện các HTTP request (hoặc aiohttp nếu bạn ưu tiên async)

pip3 install cryptography requests 

Cài đặt dotenv-python để quản lý keys của bạn một cách an toàn bằng environment variables nếu bạn sẽ sử dụng account endpointsarrow-up-right

pip3 install python-dotenv

Tạo file .env và lưu keys của bạn như sau:

PUBLIC_KEY=zDIJj9qneWIY0IYZ5aXoHcNMCm+XDhVcTssiT0HyY0A=
SECRET_KEY=4odxgSUxFrC/zsKWZF4OQwYAgnNu9hnWH3NxWfLAPz4=

Tạo file .gitignore và thêm .env để loại trừ file này khỏi version control.

.env

Đối với tất cả các ví dụ, chúng tôi sẽ sử dụng thư viện requests theo chế độ đồng bộ. Hãy import như sau:

import requests

Public endpoints

Đối với public endpoints, chỉ cần gửi một GET request.

Không yêu cầu API keys.

Ví dụ: Truy Cập Dữ Liệu Công Khai

Lưu ý: Nếu bạn có nhiều hơn một tham số, hãy nối chúng bằng ký hiệu &.

Private endpoints

Đối với private endpoints, chúng ta cần tạo các headers cụ thể và request body (đối với POST requests). Việc này yêu cầu xác thực bằng API keys của bạn.

Ví dụ: Lấy Địa Chỉ Nạp Tiền

Hãy xem cách lấy địa chỉ nạp tiền bằng API: https://docs.backpack.exchange/#tag/Capital/operation/get_deposit_addressarrow-up-right

Bây giờ chúng ta đã có các thành phần xác thực sẵn sàng (X-Timestamp, X-Window, và X-API-Key), hãy tạo chữ ký.

Ký Request

Bây giờ hãy ký request bằng private key của chúng ta:

Tạo Headers

Tạo các headers cần thiết cho API request:

Gửi Request

Bây giờ chúng ta có thể gửi request đã xác thực đến API:

Sử Dụng POST Requests

Đối với POST requests, bạn cần đưa JSON body vào và dùng phương thức post() thay vì get().

Ví dụ: Thực Thi Lệnh

Hãy xem cách gửi một lệnh đến matching engine để thực thi bằng API: https://api.backpack.exchange/api/v1/orderarrow-up-right

Nguồn

SDK giúp quá trình phát triển trở nên dễ dàng hơn.

Ví dụ SDK: https://github.com/sndmndss/bpx-pyarrow-up-right

Để biết thêm thông tin, hãy truy cập tài liệu chính thức: https://docs.backpack.exchange/arrow-up-right

Last updated