---
agentTools:
projectIndex: https://warmkey.readme.io/llms.txt
---
# Query Log
WARMKEY uses a polling-based approach instead of webhooks. Clients should query WARMKEY directly for all actions, including deposit detection and withdrawal status updates.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Endpoints",
"version": "1.0"
},
"servers": [
{
"url": "https://api.warmkey.finance"
}
],
"components": {
"schemas": {
"header": {
"type": "object",
"properties": {
"api_key": {
"type": "string"
},
"signature": {
"type": "string"
},
"nonce": {
"type": "string"
}
}
}
}
},
"paths": {
"/paymentV1/queryLog": {
"post": {
"summary": "Query Log",
"description": "WARMKEY uses a polling-based approach instead of webhooks. Clients should query WARMKEY directly for all actions, including deposit detection and withdrawal status updates.",
"tags": [
""
],
"operationId": "queryLog",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"header": {
"$ref": "#/components/schemas/header"
},
"payload": {
"type": "object",
"required": [
"log_id"
],
"properties": {
"log_id": {
"type": "string",
"format": "int64",
"description": "- Format is int64.\n- Maximum 100 records return per query, start from and include log id."
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"examples": {},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "100",
"description": "Refer to [Response & Errors](api-overview#response--errors)."
},
"message": {
"type": "string",
"example": "Success",
"description": "Refer to [Response & Errors](api-overview#response--errors)."
},
"result": {
"type": "object",
"properties": {
"log_id": {
"type": "string",
"format": "int64",
"description": "Format is int64."
},
"log_time": {
"type": "string",
"description": "Format is yyyy-mm-dd hh:mm:ss, UTC +0",
"format": "date"
},
"log_type": {
"description": "`deposit_link_created`: Deposit link is created.\n`deposit_address_changed`: The deposit address changes when a network is added or removed.\n`deposit_tx`: Incoming deposit.\n`deposit_fundout`: Deposit fund out tx.\n`withdrawal_req_created`: New withdrawal request.\n`withdrawal_status_changed`: Withdrawal status update.",
"type": "string",
"enum": [
"deposit_link_created",
"deposit_address_changed",
"deposit_tx",
"deposit_fundout",
"withdrawal_req_created",
"withdrawal_status_changed"
]
},
"deposit": {
"description": "- For log type: `deposit_address_changed`, `deposit_link_created`, `deposit_tx`.\n- Deposit record at the time.",
"type": "object",
"required": [
"address",
"path",
"create_time",
"total_amount",
"total_usd_amount"
],
"properties": {
"address": {
"description": "- Address of different network.\n- New address will be added if toggle on.\n- Old address will not be removed if toggle off.",
"type": "object",
"properties": {
"$network": {
"type": "string",
"description": "- Key is network, e.g BNBSMARTCHAIN .\n- Value is address."
}
}
},
"path": {
"type": "string",
"description": "- Value never change once created.\n- e.g 0/123"
},
"create_time": {
"type": "string",
"description": "- Value never change once created.\n- Format is yyyy-mm-dd hh:mm:ss, UTC +0",
"format": "date"
},
"total_amount": {
"description": "- Total collected crypto-amount of different coin.",
"type": "object",
"properties": {
"$network.$coin_symbol": {
"type": "string",
"format": "double",
"description": "- Key is network + coin, e.g BNBSMARTCHAIN.USDT .\n- Value is total collected crypto-amount of specific coin and format is double."
}
}
},
"total_usd_amount": {
"type": "string",
"format": "double",
"description": "- USD converted from `total_amount` field.\n- Format is double."
}
}
},
"deposit_tx": {
"description": "- For log type: `deposit_tx`.\n- Not include failed TX.",
"properties": {
"network": {
"type": "string"
},
"sender": {
"type": "string"
},
"recipient": {
"type": "string"
},
"transaction_hash": {
"type": "string"
},
"deposit_position": {
"type": "integer",
"description": "One transaction may contains many deposit transactions.\n- Value is position index which start from 0."
},
"datetime": {
"type": "string",
"description": "Format is yyyy-mm-dd hh:mm:ss, UTC +0",
"format": "date"
},
"coin_symbol": {
"type": "string"
},
"amount": {
"type": "string",
"format": "double",
"description": "- Received crypto-amount.\n- Format is double."
},
"usd_amount": {
"type": "string",
"format": "double",
"description": "- USD converted from `amount` field.\n- Format is double."
}
},
"type": "object"
},
"deposit_fundout": {
"description": "- For log type: `deposit_fundout`.",
"properties": {
"network": {
"type": "string"
},
"transaction_hash": {
"type": "string"
},
"datetime": {
"type": "string",
"description": "Format is yyyy-mm-dd hh:mm:ss, UTC +0",
"format": "date"
},
"coin_symbol": {
"type": "string"
},
"amount": {
"type": "string",
"format": "double",
"description": "- Fundout crypto-amount.\n- Format is double."
},
"usd_amount": {
"type": "string",
"format": "double",
"description": "- USD converted from `amount` field.\n- Format is double."
}
},
"type": "object"
},
"withdrawal": {
"type": "object",
"description": "- For log type: `withdrawal_req_created`, `withdrawal_status_changed`.",
"properties": {
"to": {
"type": "string",
"description": "- Format is network's address."
},
"amount": {
"type": "string",
"format": "double",
"description": "- Format is double."
},
"usd_amount": {
"type": "string",
"format": "double",
"description": "- USD converted from `amount` field.\n- Format is double."
},
"network": {
"type": "string"
},
"coin_symbol": {
"type": "string"
},
"unique_id": {
"type": "integer"
},
"receipt_id": {
"type": "integer",
"description": "Unique identifier for the withdrawal request that derived by WARMKEY."
},
"datetime": {
"type": "string",
"description": "Format is yyyy-mm-dd hh:mm:ss, UTC +0",
"format": "date"
},
"transaction_hash": {
"type": "string"
},
"withdrawal_position": {
"type": "integer",
"description": "- One transaction may contains many withdrawal transactions.\n- Value is position index which start from 0."
},
"status": {
"type": "string",
"enum": [
"pending",
"success",
"cancelled"
]
},
"status_message": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"_id": {
"buffer": {
"0": 103,
"1": 19,
"2": 54,
"3": 51,
"4": 184,
"5": 127,
"6": 26,
"7": 0,
"8": 111,
"9": 243,
"10": 61,
"11": 118
}
}
}
```