Skip to main content

zerocap-api-test

Jump restapi

Jump websocket


描述介绍

sdk install
pip install zerocap-api-test
。
。
。

restapi

get https://dma-api.defi.wiki/redoc

1. Create an order

post https://dma-api.defi.wiki/orders/create_order

请求参数:

Parameter required data type describe Value range
symbol true string Instrument USDT/AUD
side true string Side buy sell
type true string Type market limit
amount true string Quantity
price true string Price
client_order_id true string Client order id
account_vault true json accountVault

请求参数:示例(不能直接使用,需要替换自己的参数)


{
    "symbol": "USDT/AUD",
    "side": "buy",
    "type": "market",
    "amount": "1000",
    "price": "1000",
    "client_order_id": "e7f80d34-0d80-4256-9de3-cd37310a55da",
    "account_vault": {
        "third_identity_id": "918d7125916c13191f3674e",
        "api_key": "***",
        "signature": "***",
        "note": ""
    }
}

响应数据:

Parameter required data type describe Value range
id true long Transaction ID
clientOrderId true string Client order id
datatime true string Time
timestamp true string Time
lastTradeTimestamp true long Time
status true string Status
type true string Type
timeInForce true string timeInForce
side true string Side
price true string Price
average true string average
amount true string Quantity
filled true string filled
remaining true string remaining
cost true string cost
transferId true string transferId
trades true string trades

响应例子:


 {
    "id": "16ef58d1-677e-489c-8fe0-5acc4a680b6e",
    "clientOrderId": "e7f80d34-0d80-4256-9de3-cd37310a55dabe",
    "datatime": "2023-07-28 09:19:45",
    "timestamp": "1690535984000",
    "lastTradeTimestamp": "1690535984000",
    "status": "closed",
    "symbol": "USDT/AUD",
    "type": "Market",
    "timeInForce": "FOK",
    "side": "buy",
    "price": "21.1",
    "average": "1.685133171",
    "amount": "9",
    "filled": "9",
    "remaining": "0",
    "cost": "15.16619854",
    "transferId": "12424971-f51d-4144-a205-9e306eb6351c",
    "trades": [
        {
            "id": "12424971-f51d-4144-a205-9e306eb6351c",
            "timestamp": "1690535984000",
            "datetime": "2023-07-28 09:19:45",
            "symbol": "USDT/AUD",
            "order": "16ef58d1-677e-489c-8fe0-5acc4a680b6e",
            "type": "market",
            "side": "buy",
            "takerOrMaker": "taker",
            "price": "1.685133171",
            "amount": "9",
            "cost": "15.16619854",
            "orderFrom": "coinroutes"
        }
    ]
}

2. Fetch specific orders

post https://dma-api.defi.wiki/orders/fetch_order

请求参数:

Parameter required data type describe Value range
id true string Transaction ID
account_vault true json accountVault

请求参数:示例(不能直接使用,需要替换自己的参数)


{
    "id": "16ef58d1-677e-489c-8fe0-5acc4a680b6e",
    "account_vault": {
        "third_identity_id": "918d7125916c13191f3674e",
        "api_key": "***",
        "signature": "***",
        "note": ""
    }
}

响应数据 接口报错 待定:

Parameter required data type describe Value range
id true string Transaction ID
account_vault true json accountVault

响应例子:


{}

3. Batch fetch order

post https://dma-api.defi.wiki/orders/fetch_orders

请求参数:

Parameter required data type describe Value range
symbol true string symbol
start_datetime true string start_datetime
end_datetime true string end_datetime
page true string page
limit true string limit
ids true string Transaction ids
status true string status
sort_order true string sort_order
order_type true string order_type
side true string side
account_vau lt true j son accountVault

请求参数:示例(不能直接使用,需要替换自己的参数)


{
    "symbol": "",
    "start_datetime": 0,
    "end_datetime": 0,
    "page": 0,
    "limit": 0,
    "ids": "",
    "status": "",
    "sort_order": "",
    "order_type": "",
    "side": "",
    "account_vault": {
        "third_identity_id": "918d7125916c13191f3674e",
        "api_key": "***",
        "signature": "***",
        "note": ""
    }
}

响应数据 接口报错 待定:

Parameter required data type describe Value range
id true string Transaction ID
account_vault true json accountVault

响应例子:


{}

rest_api_sdk_demo

from zerocap_api_test import ZerocapRestClient

api_key = ""

api_secret = ""

client = ZerocapRestClient(api_key, api_secret)

result = client.create_order(symbol, side, type, amount, price, client_order_id, note, third_identity_id)

result = client.fetch_order(id, note="", third_identity_id="")

result = client.fetch_orders(symbol = '', start_datetime = '', end_datetime = 0, page = '', limit = '', ids = "",
                            status = "", sort_order = "", order_type = "", side = "", third_identity_id = "",
                            note = "")

websocket

1. Subscribe to Market data

websocket wss://dma-api.defi.wiki/ws/GetMarket

请求参数:

Parameter required data type describe Value range
api_key true string key
signature true long Cryptographic signature
data_type true string Subscribed Channels price

请求参数:示例(不能直接使用,需要替换自己的参数)


wss://dma-api.defi.wiki/ws/GetMarket?api_key=coinroutes&signature=2585311b823982b325b266e132cd8cdf88d190ca61706dda5a67d421b23005df&data_type=price

响应数据:

Parameter required data type describe Value range
type true long type
channel true string channel dma_price_USDT/AUD
data true jsonstr data
data['sell_price'] true string data sell price
data['buy_price'] true string data buy price
data['datetime'] true string data time
data['timestamp'] true string data time

响应例子:


{
    "type": "message",
    "channel": "dma_price_USDT/AUD",
    "data": "{
        \"sell_price\": \"1.322544321902561296\",
        \"buy_price\": \"1.668209315127094362\",
        \"datetime\": \"2023-07-28 10:03:40\",
        \"timestamp\": \"1690538620.1056492\"
        }"
}

2. Subscribe Order updates or transaction records

websocket wss://dma-api.defi.wiki/ws/GetOrdersInfo

请求参数:

Parameter required data type describe Value range
api_key true string key
signature true long Cryptographic signature
data_type true string Subscribed Channels order,trade

请求参数:示例(不能直接使用,需要替换自己的参数)


wss://dma-api.defi.wiki/ws/GetOrdersInfo?api_key=coinroutes&signature=2585311b823982b325b266e132cd8cdf88d190ca61706dda5a67d421b23005df&data_type=order,trade

dma_order_info 响应数据:

Parameter required data type describe Value range
type true long type
channel true string channel dma_order_info dma_trader_info
data true jsonstr data
data['OrderId'] true str OrderId
data['ClientOrderId'] true str ClientOrderId
data['TxnAlias'] true str TxnAlias
data['TransferId'] true str TransferId
data['Symbol'] true str Symbol
data['Type'] true str Type
data['TimeInForce'] true str TimeInForce
data['Side'] true str Side
data['OrderId'] true str OrderId
data['Price'] true str Price
data['AveragePrice'] true str AveragePrice
data['Amount'] true str Amount
data['CreatedAt'] true str CreatedAt
data['UpdatedAt'] true str UpdatedAt
data['AccountId'] true str AccountId
data['VaultId'] true str VaultId
data['Note'] true str Note
data['Status'] true str Status
data['Average'] true str Average
data['Filled'] true str Filled
data['Remaining'] true str Remaining
data['Cost'] true str Cost
data['ExecPrice'] true str ExecPrice
data['OrderFrom'] true str OrderFrom

响应例子:


{
    "type":"message",
    "channel":"dma_order_info",
    "data":"{
        \"OrderId\":\"d8be1f41-9e8e-4af0-899b-c1334916aa0e\",
        \"ClientOrderId\":\"e7f80d34-0d80-4256-9de3-cd37310a55da\",
        \"TxnAlias\":\"\",
        \"TransferId\":\"\",
        \"Symbol\":\"USDT/AUD\",
        \"Type\":\"market\",
        \"TimeInForce\":\"FOK\",
        \"Side\":\"sell\",
        \"Price\":\"1000\",
        \"AveragePrice\":\"\",
        \"Amount\":\"1000\",
        \"CreatedAt\":1690538950000,
        \"UpdatedAt\":1690538950000,
        \"AccountId\":\"1ca36d2b-2103-45c7-a2e3-3b90825ba1b2\",
        \"VaultId\":\"5175\",
        \"Note\":\"yyy_test_create_order\",
        \"Status\":\"open\",
        \"Average\":\"0\",
        \"Filled\":\"0\",
        \"Remaining\":\"1000\",
        \"Cost\":\"1000000\",
        \"ExecPrice\":\"\",
        \"OrderFrom\":\"coinroutes\
    "}"
}

websocket_sdk_demo

from zerocap_api_test import ZerocapRestClient

api_key = ""

api_secret = ""

websocket_client = ZerocapWebsocketTest(api_key, api_secret)

market_connect = websocket_client.get_market()

orders_connect = websocket_client.get_orders()

while True:

    # Get subscription messages

    message = websocket.get_message(market_connect)

    print(f"Receiving message from server: \n{message}")

    if not message:

        print("Connection close")

Metadata

Release files for sn-test 1.0.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sn-test 1.0.8
File Size Uploaded
sn_test-1.0.8.tar.gz 5.5 kB Details

Release files / sn_test-1.0.8.tar.gz

Download URL sn_test-1.0.8.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
dfef921362e656b2e1894a981bc48ae49b69ec8385d154f97af09960def66e48
BLAKE2b-256 checksum
How to use checksums
e8b909c7ccb2c1f13c21642c0f90f6f7ed1f87073749dcd84517d9a052f634de
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.6

Release history Release notifications | RSS feed

This release

1.0.8 This release

1 release file

1.0.7

1 release file

1.0.6

1 release file

1.0.5

1 release file

1.0.4

2 release files

1.0.3

1 release file

1.0.2

2 release files

1.0.1

2 release files

0.1.3

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page