> For the complete documentation index, see [llms.txt](https://docs.kanalabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kanalabs.io/perpetual-futures/kana-perps/api-docs/kana-perps-python-rest-api.md). # Kana Perps Python REST API ### **Important Note:** For all the API endpoints below, pass your wallet address as the `userAddress` parameter. To track your transactions on-chain (e.g., via **Aptos Explorer** or **Aptos Scan**), you must use your **profile address**, as all on-chain trades are executed using this profile address. To obtain your profile address, use the `/getProfileAddress` endpoint and provide your wallet address as the `userAddress` parameter. ### How to Fetch the Profile Address: **Example endpoint:**\ \ \ **Example code:**\ [https://docs.kanalabs.io/perpetual-futures/kana-perps/api-docs/kana-perps-python-rest-api#id-20.-](https://docs.kanalabs.io/perpetual-futures/kana-perps/api-docs/kana-perps-typescript-rest-api#id-19.-update-stop-loss)get-profile-address ## ✅ **Testnet API Endpoint URL** ```typescript https://perps-tradeapi.kanalabs.io ``` ### ✅ **Mainnet API Endpoint URL** ```typescript https://perps-tradeapi.kana.trade ``` ### Please ensure that the correct network is used: for Testnet, set `NODE_URL = "https://api.testnet.aptoslabs.com/v1"` and for Mainnet, set `NODE_URL = "https://api.mainnet.aptoslabs.com/v1"` ## **1. Get Market Info** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getMarketInfo`](#id-1.-get-market-info) * **Method**:\ `GET` * **Query Parameters**: * `marketId` (Required) - The ID of the market you want information about. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getMarketInfo?marketId=501 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Market information fetched successfully", "data": [ { "__variant__": "V1", "base_decimals": 8, "base_name": "APT/USDC", "counter": "0", "creator": "0xb61d7b57333abf8ac036e752f19d0ba0c4baa5404db1cbf868c57dac3628f2bf", "custodian_id": "75", "fee_address": "0x7724a4a23b25b460abc2a5d9fe1fe3c47e2a0e10a156dd713a221f129579c388", "is_recognised": false, "lot_size": "100000", "maintenance_margin": "250", "market_address": "0xcfa0086c26787035de6b4a312875c7a70b2f9a29fa880d0cf633ef3dd0acd2c3", "market_id": "1338", "market_status": 1, "max_leverage": "20", "max_lots": "150000000", "max_position_value": "125000000", "min_lots": "500", "quote_decimals": 6, "quote_precision": 3, "tick_size": "1", "timestamp": "1745079291", "underwriter_id": "73" } ] } ``` **Example Code to Fetch Market Information:** The following Python script demonstrates how to call the Get Market Info API using the requests library. ```python import requests import os from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getMarketInfo' params = { 'marketId': 501 } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_market_info = response.json() print("getMarketInfo: ", get_market_info) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **2.** Get Wallet Account Balance * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getWalletAccountBalance`](https://perps-tradeapi.kanalabs.io/getWalletAccountBalance) * **Method**:\ `GET` * **Query Parameters**: * `userAddress` (Required) - The wallet address for which the account balance is being fetched. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getWalletAccountBalance?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched wallet account balance successfully", "data": 16391.60 } ``` **Example Code to Fetch** Wallet Account Balance **Information:** The following Python script demonstrates how to call the Get Wallet Account Balance API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getWalletAccountBalance' params = { 'userAddress': '0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_wallet_account_balance = response.json() print("getWalletAccountBalance: ", get_wallet_account_balance) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **3.** Get Profile Balance Snapshot * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getProfileBalanceSnapshot`](https://perps-tradeapi.kanalabs.io/getProfileBalanceSnpashot) * **Method**:\ `GET` * **Query Parameters**: * `userAddress` (Required) - The wallet address for which the account balance is being fetched. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getProfileBalanceSnapshot?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Profile balance snapshot fetched successfully", "data": 44.321972 } ``` **Example Code to Fetch** Trading Account Balance **Information:** The following Python script demonstrates how to call the Get Trading Account Balance API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getProfileBalanceSnapshot' params = { 'userAddress': '0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_trading_account_balance = response.json() print("getTradingAccountBalance: ", get_trading_account_balance) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **4. Deposit** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/deposit`](https://perps-tradeapi.kanalabs.io/deposit) * **Method**:\ `GET` * **Query Parameters:** * `amount` (Required) - The amount of the quote coin to deposit. * `userAddress` (Required) - The address of the user making the deposit. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/deposit?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770&amount=50000000 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Deposit payload has been built successfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::deposit", "functionArguments": [ "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770", 50000000 ], "typeArguments": [] } } ``` **Example Code to Depsoit a quote coin:** The following Python script demonstrates how to call the Get Deposit API using the requests library. ```python import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.account_address import AccountAddress # Import this from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, params, headers): try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/deposit" PARAMS = { "userAddress":"0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770", "amount": 50 } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ AccountAddress.from_str(payload_data["functionArguments"][0]), int(payload_data["functionArguments"][1]), ] payload_data["argumentTypes"] = [Serializer.struct, Serializer.u64] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **5. Withdraw Specific Market** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/withdrawSpecifiMarket`](https://perps-tradeapi.kanalabs.io/withdrawSpecifiMarket) * **Method**:\ `GET` * **Query Parameters**: * `marketId` (Required) - The ID of the market you want to withdraw. * `amount` (Required) - The amount of the quote coin to withdraw. * `userAddress` (Required) - The address of the user making the withdraw. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/withdrawSpecifiMarket?marketId=501&userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770&amount=50 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Withdraw specific market payload has been built successfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::withdraw_specific_market", "functionArguments": [ "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770", "501", 50000000 ], "typeArguments": [] } } ``` **Example Code to Withdraw a quote coin:** The following Python script demonstrates how to call the Get Withdraw API using the requests library. ```python import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.account_address import AccountAddress # Import this from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, params, headers): try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/withdrawSpecifiMarket" PARAMS = { "userAddress": "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770", "marketId": 501, "amount": 50 } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ AccountAddress.from_str(payload_data["functionArguments"][0]), int(payload_data["functionArguments"][1]), int(payload_data["functionArguments"][1]), ] payload_data["argumentTypes"] = [Serializer.struct, Serializer.u64, Serializer.u64] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **6. Place Limit Order** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/placeLimitOrder`](https://perps-tradeapi.kanalabs.io/placeLimitOrder) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market where the limit order will be placed. * **tradeSide** (Required) - Indicates the trade side: * `true` for the long side. * `false` for the short side. * **direction** (Required) - Indicates the direction of the trade: * `false` to open a position. * `true` to close a position. * **size** (Required) - The size of the order. * **price** (Required) - The price at which the order is to be placed. * **leverage** (Required) - The leverage to be used for the order. * **restriction** - Specifies the type of order restriction. It is an optional parameter with a default value of `0`.\ Possible values are: * `0` - `NO_RESTRICTION`: Optionally fill as a taker, then post to the book as a maker. * `1` - `FILL_OR_ABORT`: Abort if any size posts as a maker (only fill). * `3` - `POST_OR_ABORT`: Abort if any size fills as a taker (only post). * If `restriction` is not provided, it defaults to `0`. It can either be a number or left undefined. * **takeProfit** - The take profit value is optional. If not provided, it defaults to `0`. It can either be a number or left undefined. * **stopLoss** - The stop loss value is also optional. If not provided, it defaults to `0`. It can either be a number or left undefined. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/placeLimitOrder/?marketId=501&tradeSide=true&direction=false&size=10000&price=3000&leverage=3 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Limit Order payload has been built successfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::place_limit_order", "functionArguments": [ "501", "true", "false", 1000000, 8000000, "5", 0, 0, 0 ], "typeArguments": [] } } ``` **Example Code to Place a limit order:** The following Python script demonstrates how to call the Get Place Limit Order API using the requests library. ```python import asyncio import os import requests from dotenv import load_dotenv from typing import List from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.type_tag import TypeTag, StructTag load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, params, headers): try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List, types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: module, function_id = "::".join(payload["function"].split("::")[:-1]), payload["function"].split("::")[-1] function_arguments = self.create_transaction_function_arguments(payload["functionArguments"], payload["argumentTypes"]) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural(module=module, function=function_id, ty_args=type_arguments, args=function_arguments) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction = await self.rest_client.create_bcs_signed_transaction(self.account, transaction_payload) txn_hash = await self.rest_client.submit_bcs_transaction(signed_transaction) await self.rest_client.wait_for_transaction(txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" private_key_hex = os.getenv('APTOS_PRIVATEKEY') if not private_key_hex: print("Error: APTOS_PRIVATEKEY is missing in .env file.") return account = Account.load_key(bytes.fromhex(private_key_hex[2:] if private_key_hex.startswith("0x") else private_key_hex)) rest_client = RestClient(NODE_URL) API_URL = "https://perps-tradeapi.kanalabs.io/placeLimitOrder" PARAMS = {"marketId": 501, "tradeSide": True, "direction": False, "size": 2, "price": 7, "leverage": 2} HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ int(payload_data["functionArguments"][0]), payload_data["functionArguments"][1].lower() == "true", payload_data["functionArguments"][2].lower() == "true", *map(int, payload_data["functionArguments"][3:]) ] payload_data["argumentTypes"] = [ Serializer.u64, Serializer.bool, Serializer.bool, Serializer.u64, Serializer.u64, Serializer.u64, Serializer.u8, Serializer.u64, Serializer.u64 ] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Hash: {txn_hash}") except Exception as e: print(f"Transaction process error: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **7. Place Market Order** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/placeMarketOrder`](https://perps-tradeapi.kanalabs.io/placeMarketOrder) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market where the limit order will be placed. * **tradeSide** (Required) - Indicates the trade side: * `true` for the long side. * `false` for the short side. * **direction** (Required) - Indicates the direction of the trade: * `false` to open a position. * `true` to close a position. * **size** (Required) - The size of the order. * **leverage** (Required) - The leverage to be used for the order. * **takeProfit** - The take profit value is optional. If not provided, it defaults to `0`. It can either be a number or left undefined. * **stopLoss** - The stop loss value is also optional. If not provided, it defaults to `0`. It can either be a number or left undefined. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/placeMarketOrder?marketId=66&tradeSide=false&direction=true&size=1000&leverage=20 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Market Order payload has been built successfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::place_market_order", "functionArguments": [ "501", "true", "false", 1000000, "5", 0, 0 ], "typeArguments": [] } } ``` **Example Code to Place a market order:** The following Python script demonstrates how to call the Get Place Market Order API using the requests library. ```python import asyncio import os import requests from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.type_tag import TypeTag, StructTag from dotenv import load_dotenv from typing import List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url: str, params: dict, headers: dict) -> dict | None: try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: module, function_id = "::".join(payload["function"].split("::")[:-1]), payload["function"].split("::")[-1] type_arguments = [TypeTag(StructTag.from_str(arg)) for arg in payload["typeArguments"]] function_arguments = [TransactionArgument(arg, serializer) for arg, serializer in zip(payload["functionArguments"], payload["argumentTypes"])] return TransactionPayload(payload=EntryFunction.natural(module, function_id, type_arguments, function_arguments)) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_txn = await self.rest_client.create_bcs_signed_transaction(sender=self.account, payload=transaction_payload) txn_hash = await self.rest_client.submit_bcs_transaction(signed_transaction=signed_txn) await self.rest_client.wait_for_transaction(txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" API_URL = "https://perps-tradeapi.kanalabs.io/placeMarketOrder" HEADERS = {"x-api-key": os.getenv('API_KEY')} PARAMS = {"marketId": 501, "tradeSide": True, "direction": False, "size": 2, "leverage": 2} rest_client = RestClient(NODE_URL) private_key = os.getenv('APTOS_PRIVATEKEY', "").lstrip("0x") if not private_key: print("Error: APTOS_PRIVATEKEY is missing in .env file.") return account = Account.load_key(bytes.fromhex(private_key)) handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ int(payload_data["functionArguments"][0]), payload_data["functionArguments"][1].lower() == "true", payload_data["functionArguments"][2].lower() == "true", *map(int, payload_data["functionArguments"][3:]) ] payload_data["argumentTypes"] = [Serializer.u64, Serializer.bool, Serializer.bool] + [Serializer.u64] * (len(payload_data["functionArguments"]) - 3) transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **8. Cancel Multiple Orders** * **Endpoint URL**:\ [`htps://perps-tradeapi.kanalabs.io/cancelMultipleOrders`](#api-overview) * **Method**:\ `POST` * **Request Body**: * **marketId**: The ID of the market for which the orders will be canceled. * cancelOrderIds: A list of order IDs to cancel. * orderSides: The sides of the orders to cancel (true for long, false for short). **Example Request:** ```json { "marketId": 501, "cancelOrderIds": ["1077898597726583798162207", "1077880153515406921884445"], "orderSides": [true, false] } ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Cancel Multiple Orders payload has been built successfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::cancel_multiple_orders", "functionArguments": [ 501, [ "1077898597726583798162207", "1077880153515406921884445" ], [ true, false ] ], "typeArguments": [] } } ``` **Example Code to Cancel multiple orders:** The following Python script demonstrates how to call the Post Cancel Multiple Orders API using the requests library. ```python import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, json_data, headers): try: response = requests.post(api_url, json=json_data, headers=headers) response.raise_for_status() payload_data = response.json().get("data") if payload_data is None: print("No data returned from API.") return {} # Convert order ID from float to integer payload_data["functionArguments"][1] = [int(x) for x in payload_data["functionArguments"][1]] return payload_data except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") try: return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] except Exception as e: print(f"Error creating transaction arguments: {e}") raise def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/cancelMultipleOrders" BODY = { "marketId": 501, "cancelOrderIds": ["85722020555623231393816"], # pls ensure cancelOrderIds given in string "orderSides": [True] } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, BODY, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["argumentTypes"] = [ Serializer.u64, Serializer.sequence_serializer(Serializer.u128), Serializer.sequence_serializer(Serializer.bool) ] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **8. Place Multiple Orders** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/placeMultipleOrders`](https://perps-tradeapi.kanalabs.io/placeMultipleOrders) * **Method**:\ `POST` Request Body : * marketId (Required) - The ID of the market where the orders will be placed. * orderTypes (Required) - An array of order types for each order: * true for limit orders. * false for market orders. * tradeSides (Required) - An array indicating the trade sides for each order: * true for long positions. * false for short positions. * directions (Required) - An array indicating the direction of each trade: * false to open a position. * true to close a position. * sizes (Required) - An array of sizes for each order. * leverages (Required) - An array of leverages for each order. * prices (Required) - An array of prices at which each order is to be placed. * **restriction** - Specifies the type of order restriction. It is an optional parameter with a default value of `0`.\ Possible values are: * `0` - `NO_RESTRICTION`: Optionally fill as a taker, then post to the book as a maker. * `1` - `FILL_OR_ABORT`: Abort if any size posts as a maker (only fill). * `3` - `POST_OR_ABORT`: Abort if any size fills as a taker (only post). * If `restriction` is not provided, it defaults to `0`. It can either be a number or left undefined. * **takeProfits** - The take profit value is optional. If not provided, it defaults to `0`. It can either be a number or left undefined. * **stopLosses** - The stop loss value is also optional. If not provided, it defaults to `0`. It can either be a number or left undefined. **Example Request:** ```json { "marketId": 501, "orderTypes": [true, true], "tradeSides": [true, true], "directions": [true, true], "sizes": [1000, 1000], "prices": [1000, 1000], "leverages": [2, 2] } ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Multiple Orders payload has been built successfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::place_multiple_orders", "functionArguments": [ 501, [ true, true ], [ true, true ], [ true, true ], [ 1000, 1000 ], [ 4670, 6780 ], [ 2, 2 ], [ 0, 0 ], [ 4600 ], [ 0, 0 ] ], "typeArguments": [] } } ``` **Example Code to Place a multiple orders:** The following Python script demonstrates how to call the Get Place Multiple Orders API using the requests library. ```python import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url: str, json_data: dict, headers: dict) -> dict: try: response = requests.post(api_url, json=json_data, headers=headers) response.raise_for_status() payload_data = response.json().get("data") if payload_data is None: print("No data returned from API.") return {} # Dynamically ensure the length matches the sizes provided payload_data["takeProfits"] = payload_data.get("takeProfits", [0] * len(json_data["sizes"])) payload_data["stopLosses"] = payload_data.get("stopLosses", [0] * len(json_data["sizes"])) payload_data["restrictions"] = payload_data.get("restrictions", [0] * len(json_data["sizes"])) return payload_data except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return {} def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") try: return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] except Exception as e: print(f"Error creating transaction arguments: {e}") raise def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/placeMultipleOrders" BODY = { "marketId": 501, "orderTypes": [True], "tradeSides": [True], "directions": [False], "sizes": [1.9], "prices": [4.12], "leverages": [2] } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, BODY, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["argumentTypes"] = [ Serializer.u64, Serializer.sequence_serializer(Serializer.bool), Serializer.sequence_serializer(Serializer.bool), Serializer.sequence_serializer(Serializer.bool), Serializer.sequence_serializer(Serializer.u64), Serializer.sequence_serializer(Serializer.u64), Serializer.sequence_serializer(Serializer.u64), Serializer.sequence_serializer(Serializer.u8), Serializer.sequence_serializer(Serializer.u64), Serializer.sequence_serializer(Serializer.u64) ] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **9. Cancel and Place Multiple Orders** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/cancelAndPlaceMultipleOrders`](https://perps-tradeapi.kanalabs.io/cancelAndPlaceMultipleOrders) * **Method**:\ `POST` Request Body : * marketId (Required) - The ID of the market where the orders will be placed. * cancelOrderIds **(Required)** - An array of strings representing the IDs of the orders to be canceled. * orderSides **(Required)** - An array indicating the sides of the orders being canceled: * `true` for long sides. * `false` for short sides. * orderTypes (Required) - An array of order types for each order: * true for limit orders. * false for market orders. * tradeSides (Required) - An array indicating the trade sides for each order: * true for long positions. * false for short positions. * directions (Required) - An array indicating the direction of each trade: * false to open a position. * true to close a position. * sizes (Required) - An array of sizes for each order. * leverages (Required) - An array of leverages for each order. * prices (Required) - An array of prices at which each order is to be placed. * **restriction** - Specifies the type of order restriction. It is an optional parameter with a default value of `0`.\ Possible values are: * `0` - `NO_RESTRICTION`: Optionally fill as a taker, then post to the book as a maker. * `1` - `FILL_OR_ABORT`: Abort if any size posts as a maker (only fill). * `3` - `POST_OR_ABORT`: Abort if any size fills as a taker (only post). * If `restriction` is not provided, it defaults to `0`. It can either be a number or left undefined * **takeProfits** - The take profit value is optional. If not provided, it defaults to `0`. It can either be a number or left undefined. * **stopLosses** - The stop loss value is also optional. If not provided, it defaults to `0`. It can either be a number or left undefined. **Example Request:** ```json { "marketId": 501, "cancelOrderIds": ["23434565434567", "454345665456"], "orderSides": [true, true], "orderTypes": [true, true], "tradeSides": [true, false], "directions": [true, true], "sizes": [1000, 2000], "prices": [5000, 6000], "leverages": [2, 2] } ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Cancel and place multiple Orders payload has been built successfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::cancel_and_place_multiple_orders", "functionArguments": [ 501, [ "23434565434567", "454345665456" ], [ "true", "true" ], [ true, true ], [ true, false ], [ true, true ], [ 1000, 2000 ], [ 5000, 6000 ], [ 2, 2 ], [ 0, 0 ], [ 0, 0 ], [ 0, 0 ] ], "typeArguments": [] } } ``` **Example Code to cancel and Place a multiple orders:** The following TypeScript/Node.js script demonstrates how to call the Get Cancel And Place Multiple Orders API using the `axios` library. ```python import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url: str, json_data: dict, headers: dict) -> dict: try: response = requests.post(api_url, json=json_data, headers=headers) response.raise_for_status() payload_data = response.json().get("data") if payload_data is None: print("No data returned from API.") return {} # Ensure correct integer representation for order IDs payload_data["takeProfits"] = payload_data.get("takeProfits", [0] * len(json_data["sizes"])) payload_data["stopLosses"] = payload_data.get("stopLosses", [0] * len(json_data["sizes"])) payload_data["restrictions"] = payload_data.get("restrictions", [0] * len(json_data["sizes"])) # Convert order ID lists from float to integer payload_data["functionArguments"][1] = [int(x) for x in payload_data["functionArguments"][1]] return payload_data except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return {} def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") try: return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] except Exception as e: print(f"Error creating transaction arguments: {e}") raise def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] if "argumentTypes" not in payload: raise KeyError("'argumentTypes' missing in payload.") function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/cancelAndPlaceMultipleOrders" BODY = { "marketId": 501, "cancelOrderIds": ["45877054622524009092208"], # Ensure orderId given as string "orderSides": [True], "orderTypes": [True], "tradeSides": [True], "directions": [False], "sizes": [1.8], "prices": [7.6868], "leverages": [2] } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, BODY, HEADERS) print("Before payload:", payload_data) if not payload_data: print("Failed to fetch payload data.") return # Ensure argumentTypes is included in payload_data payload_data["argumentTypes"] = [ Serializer.u64, # marketId Serializer.sequence_serializer(Serializer.u128), Serializer.sequence_serializer(Serializer.bool), Serializer.sequence_serializer(Serializer.bool), # orderTypes Serializer.sequence_serializer(Serializer.bool), # tradeSides Serializer.sequence_serializer(Serializer.bool), # directions Serializer.sequence_serializer(Serializer.u64), # sizes Serializer.sequence_serializer(Serializer.u64), # prices Serializer.sequence_serializer(Serializer.u64), # leverages Serializer.sequence_serializer(Serializer.u8), # restrictions Serializer.sequence_serializer(Serializer.u64), # takeProfits Serializer.sequence_serializer(Serializer.u64), # stopLosses ] try: print("After payload:", payload_data) transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **10.** Get Open Orders * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getOpenOrders`](https://perps-tradeapi.kanalabs.io/getOpenOrders) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The wallet address to retrieve open orders for. * **marketId** - The ID of the market to filter open orders. // Optional ``` Note : order_type Explanation: OPEN_LONG (1): Opens a new long position. OPEN_SHORT (2): Opens a new short position. INCREASE_LONG (3): Increases the size of an existing long position. INCREASE_SHORT (4): Increases the size of an existing short position. DECREASE_LONG (5): Reduces the size of an existing long position. DECREASE_SHORT (6): Reduces the size of an existing short position. CLOSE_LONG (7): Closes an existing long position. CLOSE_SHORT (8): Closes an existing short position. ``` **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getOpenOrders?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770&marketId=66 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched open orders successfully", "data": [ { "address": "0x3c78886aa67752706b3502b12959edf92e68d85ae64b24226783d26ce6efc1e", "market_id": "501", "leverage": 2, "order_type": 3, "timestamp": 1741444213, "price": "7", "total_size": "2", "remaining_size": "2", "order_value": "14", "order_id": "645636324063400958808", "trade_id": "295147905179352826357", "last_updated": 1741444214, "transaction_version": 6703807706 }, { "address": "0x3c78886aa67752706b3502b12959edf92e68d85ae64b24226783d26ce6efc1e", "market_id": "501", "leverage": 2, "order_type": 3, "timestamp": 1741445758, "price": "7", "total_size": "2", "remaining_size": "2", "order_value": "14", "order_id": "682529812245179800408", "trade_id": "295147905179352826357", "last_updated": 1741445758, "transaction_version": 6703807706 } ] } ``` **Example Code to Fetch** Open Orders**:** The following Python script demonstrates how to call the Get Open Orders API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getOpenOrders' params = { 'marketId': 501, 'userAddress': "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770" } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_open_orders = response.json() print("getOpenOrders: ", get_open_orders) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **11.** Get Order History * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getOrderHistory`](https://perps-tradeapi.kanalabs.io/getOrderHistory) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The wallet address to retrieve the order history. * **marketId** (optional) - The ID of the market to filter the order history. * offset (Optional) - The offset for paginating the results.\ limit (Optional) - The maximum number of results to return.\ order (Optional) - The sort order of the results. Accepts `asc` or `desc`. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getOrderHistory?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770&marketId=66 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched order history successfully", "data": [ { "address": "0x3c78886aa67752706b3502b12959edf92e68d85ae64b24226783d26ce6efc1e", "market_id": "501", "leverage": 2, "order_type": 1, "timestamp": 1741167151, "is_market_order": false, "size": "1.50", "price": "4.678", "order_value": "7.01700", "status": "Open", "order_id": "18446884819787846214", "trade_id": "18446744073709552117", "last_updated": 1741262093, "transaction_version": 6703807706 }, { "address": "0x3c78886aa67752706b3502b12959edf92e68d85ae64b24226783d26ce6efc1e", "market_id": "501", "leverage": 2, "order_type": 1, "timestamp": 1741236277, "is_market_order": false, "size": "1.50", "price": "4.678", "order_value": "7.01700", "status": "Cancelled", "order_id": "18446884819787846214", "trade_id": "18446744073709552117", "last_updated": 1741262168, "transaction_version": 6703807706 }, { "address": "0x3c78886aa67752706b3502b12959edf92e68d85ae64b24226783d26ce6efc1e", "market_id": "501", "leverage": 2, "order_type": 1, "timestamp": 1741236468, "is_market_order": false, "size": "1.50", "price": "4.50", "order_value": "6.7500", "status": "Open", "order_id": "36893628893497397652", "trade_id": "36893488147419103733", "last_updated": 1741262168, "transaction_version": 6703807706 } } ] ``` **Example Code to Fetch Order History:** The following Python script demonstrates how to call the Get Order History API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getOrderHistory' params = { 'marketId': 501, 'userAddress': "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770" } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_order_history = response.json() print("getOrderHistory: ", get_order_history) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **12.** Get Positions * **Endpoint URL**:\ [h`ttps://perps-tradeapi.kanalabs.io/getPositions`](https://perps-tradeapi.kanalabs.io/getPositions) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The wallet address of the user to view positions for. * **marketId** (optional) - The ID of the market to filter the positions. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getPositions?marketId=66&userAddress=0x2eda5777ed2bf68cbcc67359dd00ae5fa73b1d5fa160b7c3aeb42d748d485387 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched positions successfully", "data": [ { "address": "0x3c78886aa67752706b3502b12959edf92e68d85ae64b24226783d26ce6efc1e", "market_id": "501", "leverage": 2, "trade_side": true, "size": "1", "available_order_size": "1", "value": "5.678", "entry_price": "5.678", "liq_price": "2.9117948717948717990163355253", "margin": "2.839", "tp": "6.012", "sl": null, "trade_id": "295147905179352826357", "last_updated": 1741262185, "transaction_version": 6703807706 } ] } ``` **Example Code to Fetch** Open Position**:** The following Python script demonstrates how to call the Get Open Position API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getPositions' params = { 'marketId': 501, 'userAddress': "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770" } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_open_position = response.json() print("getOpenPosition: ", get_open_position) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **13.** Get Order Status By Order Id * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getOrderStatusByOrderId`](https://perps-tradeapi.kanalabs.io/getOrderStatusByOrderId) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market associated with the order. * **orderId** (Required) - The unique identifier of the order to retrieve its status. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getOrderStatusByOrderId?marketId=66&orderId=15308325717473050761363456 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "status": true, "message": "Fetched order status for a given order Id successfully", "data": { "market_id": 66, "order_id": "15308325717473050761363456", "created_at": "2024-11-20T11:54:45.957059+00:00", "last_updated_at": "2024-11-20T11:54:45.957059+00:00", "integrator": "0xee820ab02631dd1a195d3c53fa64f0a8f455dbb9261388e141c3bd3bd3c08363", "total_filled": 1000, "remaining_size": 0, "order_status": "closed", "order_type": "market", "user": "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770", "direction": "buy", "price": 0, "average_execution_price": 12813, "custodian_id": 28, "self_match_behavior": 0, "restriction": 0, "last_increase_stamp": null, "min_base": null, "max_base": null, "min_quote": null, "max_quote": null, "total_fees_paid_in_quote_subunits": 6406 } } ``` **Example Code to Fetch** Order Status B Order Id**:** The following Python script demonstrates how to call the Get Order Status By Order Id API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getOrderStatusByOrderId' params = { 'marketId': 501, 'orderId': '85703575078023708283016' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_order_status_by_order_id = response.json() print("getOrderStatusByOrderId: ", get_order_status_by_order_id) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **14.** Get Fills **Note:**\ For the `getFills` endpoint, you must pass the **profile address**, not the wallet address.\ Please make sure to first call the **Get Profile Address** endpoint and use that returned address as the `address` parameter in the `getFills` request. * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getFills`](https://perps-tradeapi.kanalabs.io/getFills) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market for which fills are retrieved. * **address** (Optional) - The address of the user to filter fills (if applicable). * **from** (Required) - The start time of the range in ISO 8601 format (e.g., `2024-11-21T00:00:00Z`). * **to** (Required) - The end time of the range in ISO 8601 format (e.g., `2024-11-21T23:59:59Z`). * **orderId** (Required) - The unique identifier of the order to retrieve its status. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getFills?marketId=66&address=0x3a6b332c7889784fe57ea61f507b5056e386db8f56c6323b4d898485f468f0c2&from=2024-11-20T00:00:00Z&to=2024-11-21T23:59:59Z ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched fill trades for a given time range Successfully", "data": [ { "txn_version": 6296434935, "event_idx": 1, "emit_address": "0x3a6b332c7889784fe57ea61f507b5056e386db8f56c6323b4d898485f468f0c2", "time": "2024-11-20T19:23:14.67535+00:00", "maker_address": "0x2eda5777ed2bf68cbcc67359dd00ae5fa73b1d5fa160b7c3aeb42d748d485387", "maker_custodian_id": 28, "maker_order_id": "15891335065048614061485282", "maker_side": true, "market_id": 66, "price": 11490, "sequence_number_for_trade": 0, "size": 1000, "taker_address": "0x3a6b332c7889784fe57ea61f507b5056e386db8f56c6323b4d898485f468f0c2", "taker_custodian_id": 28, "taker_order_id": "15891427297643009687945216", "taker_quote_fees_paid": 5745 }, { "txn_version": 6295302625, "event_idx": 4, "emit_address": "0x3a6b332c7889784fe57ea61f507b5056e386db8f56c6323b4d898485f468f0c2", "time": "2024-11-20T18:19:35.70863+00:00", "maker_address": "0x2eda5777ed2bf68cbcc67359dd00ae5fa73b1d5fa160b7c3aeb42d748d485387", "maker_custodian_id": 28, "maker_order_id": "15812401447297883953966476", "maker_side": false, "market_id": 66, "price": 11660, "sequence_number_for_trade": 0, "size": 1000, "taker_address": "0x3a6b332c7889784fe57ea61f507b5056e386db8f56c6323b4d898485f468f0c2", "taker_custodian_id": 28, "taker_order_id": "15812549019983827645235200", "taker_quote_fees_paid": 5830 } ] } ``` **Example Code to Fetch** Order Status B Order IdFills Data**:** The following Python script demonstrates how to call the Get Fills Data API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getFills' params = { 'marketId': 'your_market_id', 'address': 'your_address', 'from': 'your_from_time', 'to': 'your_to_time' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_fills_data = response.json() print("getFillsData: ", get_fills_data) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **14.** Get Market Price * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getMarketPrice`](https://perps-tradeapi.kanalabs.io/getMarketPrice) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market for which the price information is being retrieved. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getMarketPrice?marketId=66 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched Market Price Successfully", "data": { "bestAskPrice": 6.400, "bestBidPrice": 9.880 } } ``` **Example Code to Fetch** Market Price**:** The following Python script demonstrates how to call the Get Market Price API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getMarketPrice' params = { 'marketId': 501 } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_market_price = response.json() print("getMarketPrice: ", get_market_price) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **15.** Get Last Execution Price * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getLastPlacedPrice`](https://perps-tradeapi.kanalabs.io/getLastPlacedPrice) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market for which the last execution price information is being retrieved. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getLastPlacedPrice?marketId=66 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched last execution price Successfully", "data": 8.989 } ``` **Example Code to Fetch** Last Execution Price**:** The following Python script demonstrates how to call the Get Last Execution Price API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getLastPlacedPrice' params = { 'marketId': 501 } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_last_execution_price = response.json() print("getLastExecutionPrice: ", get_last_execution_price) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **16.** Get All Open Order Ids * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getAllOpenOrderIds`](https://perps-tradeapi.kanalabs.io/getAllOpenOrderIds) * **Method**:\ `GET` * **Query Parameters**: * userAddress(Required) - The address associated with the orders. * **marketId** (optional) - The ID of the market for which open order IDs are being retrieved. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getAllOpenOrderIds?marketId=66&userAddress=0x3a6b332c7889784fe57ea61f507b5056e386db8f56c6323b4d898485f468f0c2 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Open order IDs fetched successfully", "data": [ "645636324063400958808", "682529812245179800408", "700976556301709482840", "719423300401188838232", "737869903703050289159", "756316647793939709959" ] } ``` **Example Code to Fetch** Open Order Ids**:** The following Python script demonstrates how to call the Get Open Order Ids API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getAllOpenOrderIds' params = { 'userAddress': '0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770', 'marketId': 501 } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_open_order_ids = response.json() print("getOpenOrderIds: ", get_open_order_ids) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **17. Update Take Profit** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/updateTakeProfit`](https://perps-tradeapi.kanalabs.io/updateTakeProfit) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market for which the take profit values will be updated. * **tradeSide** (Required) - The trade side: * `true` for the long side. * `false` for the short side. * **newTakeProfitPrice** (Required) - The new take profit price to be set for the trade. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/updateTakeProfit?marketId=66&tradeSide=true&newTakeProfitPrice=6000 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Update take profit payload built succesfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::update_take_profit", "functionArguments": [ "501", "true", 7590 ], "typeArguments": [] } } ``` **Example Code to Update take profit price:** The following Python script demonstrates how to call the Get Update Take Profit Price API using the requests library. ```python import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, params, headers): try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/updateTakeProfit" PARAMS = { "marketId": 501, "tradeSide": True, "newTakeProfitPrice": 6.89 } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ int(payload_data["functionArguments"][0]), payload_data["functionArguments"][1].lower() == "true", int(payload_data["functionArguments"][2]), ] payload_data["argumentTypes"] = [Serializer.u64, Serializer.bool, Serializer.u64] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **18.** Get Account Aptos Balance * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getAccountAptBalance`](https://perps-tradeapi.kanalabs.io/getAccountAptBalance) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The address of the account whose balance will be **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getAccountAptBalance?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched Account Apt Balance Successfully", "data": 8.2344617 } ``` **Example Code to Fetch** Wallet Account Aptos Balance **Information:** The following Python script demonstrates how to call the Get Wallet Account Aptos Balance API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getAccountAptBalance' params = { 'userAddress': '0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_wallet_account_aptos_balance = response.json() print("getWalletAccountAptosBalance: ", get_wallet_account_aptos_balance) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **19. Update Stop Loss** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/updateStopLoss`](https://perps-tradeapi.kanalabs.io/updateStopLoss) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market for which the take profit values will be updated. * **tradeSide** (Required) - The trade side: * `true` for the long side. * `false` for the short side. * newStopLossPrice (Required) - The new stop loss price to be set for the trade. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/updateStopLoss?marketId=66&tradeSide=true&newStopLossPrice=6000 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Update stop loss payload built succesfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::update_stop_loss", "functionArguments": [ "501", "true", 7590 ], "typeArguments": [] } } ``` **Example Code to Update stop loss price:** The following Python script demonstrates how to call the Get Update Stop Loss Price API using the requests library. ```python import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, params, headers): try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/updateStopLoss" PARAMS = { "marketId": 501, "tradeSide": True, "newStopLossPrice": 6.89 } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ int(payload_data["functionArguments"][0]), payload_data["functionArguments"][1].lower() == "true", int(payload_data["functionArguments"][2]), ] payload_data["argumentTypes"] = [Serializer.u64, Serializer.bool, Serializer.u64] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **20. Get Profile Address** * **Endpoint URL**: [`https://perps-tradeapi.kanalabs.io/getProfileAddress`](https://perps-tradeapi.kanalabs.io/getProfileAddress) * **Method**: `GET` * **Query Parameters**: * `userAddress`(Required) - The address of the user to get the profile address. **Example Request:** Copy ``` GET https://perps-tradeapi.kanalabs.io/getProfileAddress?userAddress=0xd01e3a233632a41463bd6d289e99e69e1b50815c7afff710e1c992659a8722f3 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: Copy ```typescript { "success": true, "message": "Profile address fetched successfully", "data": "0x56ad3b670c9193414e5f3dbc1d9caf7a08368c4ab0b4b29c00ce13c463f6d934" } ``` **Example Code to Fetch the profile address:** The following TypeScript/Node.js script demonstrates how to call the Get profile address API using the `axios` library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getProfileAddress' params = { 'userAddress': '0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_wallet_account_balance = response.json() print("getWalletAccountBalance: ", get_wallet_account_balance) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **21. Collapse position** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/collapsePosition`](https://perps-tradeapi.kanalabs.io/collapsePosition) * **Method**:\ `GET` * **Query Parameters**: * `marketId` (Required) - The ID of the market you want to collapse a position. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/collapsePosition?marketId=501 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "collapse position payload built succesfully", "data": { "function": "0xabbf40e0c31cbedf182f3e6e9c3570f3f91629424723da876becb514bf5d9fc6::perpetual_scripts::collapse_position", "functionArguments": [ "624" ], "typeArguments": [] } } ``` **Example Code to collapse a position:** The following TypeScript/Node.js script demonstrates how to call the collapse position API using the `axios` library. ```typescript import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.account_address import AccountAddress # Import this from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, params, headers): try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/collapsePosition" PARAMS = { "marketId": 624 } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ int(payload_data["functionArguments"][0]) ] payload_data["argumentTypes"] = [Serializer.u64] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **22.** Get All Trades * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getAllTrades`](https://perps-tradeapi.kanalabs.io/getAllTrades) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market to retrieve all trades information. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getAllTrades?marketId=66 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Recent trades fetched successfully", "data": [ { "txn_version": 6297687196, "event_idx": 5, "emit_address": "0x2eda5777ed2bf68cbcc67359dd00ae5fa73b1d5fa160b7c3aeb42d748d485387", "time": "2024-11-20T20:33:38.600241+00:00", "maker_address": "0x2eda5777ed2bf68cbcc67359dd00ae5fa73b1d5fa160b7c3aeb42d748d485387", "maker_custodian_id": 28, "maker_order_id": "15951655917465922493754983", "maker_side": true, "market_id": 66, "price": 11879, "sequence_number_for_trade": 0, "size": 10000, "taker_address": "0x13eb7ea6b62c6cd791b5c4e0e2ef1dfbe59d1cf4823929343a273274c288bc8a", "taker_custodian_id": 28, "taker_order_id": "15951748150764039921729536", "taker_quote_fees_paid": 59395 }, { "txn_version": 6297687196, "event_idx": 4, "emit_address": "0x13eb7ea6b62c6cd791b5c4e0e2ef1dfbe59d1cf4823929343a273274c288bc8a", "time": "2024-11-20T20:33:38.600241+00:00", "maker_address": "0x2eda5777ed2bf68cbcc67359dd00ae5fa73b1d5fa160b7c3aeb42d748d485387", "maker_custodian_id": 28, "maker_order_id": "15951655917465922493754983", "maker_side": true, "market_id": 66, "price": 11879, "sequence_number_for_trade": 0, "size": 10000, "taker_address": "0x13eb7ea6b62c6cd791b5c4e0e2ef1dfbe59d1cf4823929343a273274c288bc8a", "taker_custodian_id": 28, "taker_order_id": "15951748150764039921729536", "taker_quote_fees_paid": 59395 } ] } ``` **Example Code to Fetch** All trades**:** The following Python script demonstrates how to call the Get Open Position API using the requests library. ```typescript import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getAlllTrades' params = { marketId: 'your_market_id' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() getAlllTrades= response.json() print("getAlllTrades: ", getAlllTrades) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **23.** Get Account Apt Balance * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getAccountAptBalance`](https://perps-tradeapi.kanalabs.io/getAccountAptBalance)\ \ **Method**:\ `GET` * **Query Parameters**: * `userAddress` (Required) - The wallet address for which the account balance is being fetched. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getAccountAptBalance?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched wallet apt balance successfully", "data": 91.60 } ``` **Example Code to Fetch** Account Apt Balance **Information:** The following TypeScript/Node.js script demonstrates how to call the Get Account Apt Balance API using the `axios` library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getAccountAptBalance' params = { 'userAddress': '0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() getAccountAptBalance = response.json() print("getAccountAptBalance: ", getAccountAptBalance) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## 24. Get Perpetual Asset Info **Endpoint URL:**\ `https://perps-tradeapi.kanalabs.io/getPerpetualAssetsInfo` **Method:**\ `GET` **Query Parameters:** * `marketId` (optional) – Numeric ID of the market to fetch. * `baseName` (optional) – Name of the base asset (e.g., `"ETH"`, `"BTC"`). **Note:** Either `marketId` or `baseName` must be provided. If neither is provided, the server will respond with a `400` error. **Example Request:** ``` GET https://perps-tradeapi.kanalabs.io/getPerpetualAssetsInfo?marketId=1338 ``` **Example Response:** ```json { "success": true, "message": "Fetched market infos successfully", "data": [ { "__variant__": "V1", "base_decimals": 8, "base_name": "APT/USDC", "counter": "9473", "creator": "0xb61d7b57333abf8ac036e752f19d0ba0c4baa5404db1cbf868c57dac3628f2bf", "fee_address": "0x7724a4a23b25b460abc2a5d9fe1fe3c47e2a0e10a156dd713a221f129579c388", "is_recognised": false, "last_updated": "1745235856", "lot_size": "100000", "maintenance_margin": "250", "market_address": "0xcfa0086c26787035de6b4a312875c7a70b2f9a29fa880d0cf633ef3dd0acd2c3", "market_id": "1338", "market_status": 1, "max_leverage": "20", "max_lots": "150000000", "max_position_value": "125000000000", "min_lots": "500", "quote_decimals": 6, "quote_precision": 3, "tick_size": "1" } ] } ``` **Example Code:** ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getPerpetualAssetsInfo' params = { 'marketId': '1338' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() getPerpetualAssetsInfo = response.json() print("getPerpetualAssetsInfo: ", getPerpetualAssetsInfo) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` *** ### Get All Perpetual Market Assets **Endpoint URL:**\ `https://perps-tradeapi.kanalabs.io/getPerpetualAssetsInfo/allMarkets` **Method:**\ `GET` **Description:**\ Fetches all available perpetual market asset information. This endpoint does not require any query parameters. **Example Request:** ``` GET https://perps-tradeapi.kanalabs.io/getPerpetualAssetsInfo/allMarkets ``` **Example Response:** ```json { "success": true, "message": "Fetched market infos successfully", "data": [ { "__variant__": "V1", "base_decimals": 8, "base_name": "APT/USDC", "counter": "9473", "creator": "0xb61d7b57333abf8ac036e752f19d0ba0c4baa5404db1cbf868c57dac3628f2bf", "fee_address": "0x7724a4a23b25b460abc2a5d9fe1fe3c47e2a0e10a156dd713a221f129579c388", "is_recognised": false, "last_updated": "1745235856", "lot_size": "100000", "maintenance_margin": "250", "market_address": "0xcfa0086c26787035de6b4a312875c7a70b2f9a29fa880d0cf633ef3dd0acd2c3", "market_id": "1338", "market_status": 1, "max_leverage": "20", "max_lots": "150000000", "max_position_value": "125000000000", "min_lots": "500", "quote_decimals": 6, "quote_precision": 3, "tick_size": "1" }, { "__variant__": "V1", "base_decimals": 8, "base_name": "BTC/USDC", "counter": "4813", "creator": "0xb61d7b57333abf8ac036e752f19d0ba0c4baa5404db1cbf868c57dac3628f2bf", "fee_address": "0x7724a4a23b25b460abc2a5d9fe1fe3c47e2a0e10a156dd713a221f129579c388", "is_recognised": false, "last_updated": "1745235864", "lot_size": "1000", "maintenance_margin": "250", "market_address": "0xc4de5894f6a97168998719c10f517572cbe10fe6911ca25004fbe87a88247ed4", "market_id": "1339", "market_status": 1, "max_leverage": "20", "max_lots": "6000000", "max_position_value": "125000000000", "min_lots": "10", "quote_decimals": 6, "quote_precision": 0, "tick_size": "10" }, { "__variant__": "V1", "base_decimals": 8, "base_name": "ETH/USDC", "counter": "3377", "creator": "0xb61d7b57333abf8ac036e752f19d0ba0c4baa5404db1cbf868c57dac3628f2bf", "fee_address": "0x7724a4a23b25b460abc2a5d9fe1fe3c47e2a0e10a156dd713a221f129579c388", "is_recognised": false, "last_updated": "1745235871", "lot_size": "10000", "maintenance_margin": "250", "market_address": "0x9e173d4330b94718fd09c3d1d18b707f2713a1cd92e79403ee150429c3125718", "market_id": "1340", "market_status": 1, "max_leverage": "20", "max_lots": "10000000", "max_position_value": "125000000000", "min_lots": "10", "quote_decimals": 6, "quote_precision": 1, "tick_size": "10" } ] } ``` **Example Code:** ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getPerpetualAssetsInfo/allMarkets' api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, headers=headers) response.raise_for_status() getPerpetualAssetsInfo = response.json() print("getPerpetualAssetsInfo: ", getPerpetualAssetsInfo) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **25. Add Margin** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/addMargin`](https://perps-tradeapi.kanalabs.io/addMargin) * **Method**:\ `GET` * **Query Parameters**: * **marketId (Required)** – The unique identifier of the market where the margin is being added. * **tradeSide** (Required) - Indicates the trade side: * `true` for the long side. * `false` for the short side. * **amount (Required)** – The amount of additional margin to be added to the position. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/addMargin?marketId=1338&tradeSide=true&amount=1 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Add Margin payload built successfully", "data": { "function": "0x732f891290449af5e9369866537a51a8e7dc566791aec61a468223ed840b1eb4::perpetual_scripts::add_margin", "functionArguments": [ "1338", "true", 1000000 ], "typeArguments": [] } } ``` **Example Code to add a margin:** The following python demonstrates how to call the Get Add Margin API using the `axios` library. ```python import asyncio import os import requests from dotenv import load_dotenv from typing import List from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.type_tag import TypeTag, StructTag load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, params, headers): try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List, types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: module, function_id = "::".join(payload["function"].split("::")[:-1]), payload["function"].split("::")[-1] function_arguments = self.create_transaction_function_arguments(payload["functionArguments"], payload["argumentTypes"]) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural(module=module, function=function_id, ty_args=type_arguments, args=function_arguments) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction = await self.rest_client.create_bcs_signed_transaction(self.account, transaction_payload) txn_hash = await self.rest_client.submit_bcs_transaction(signed_transaction) await self.rest_client.wait_for_transaction(txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" private_key_hex = os.getenv('APTOS_PRIVATEKEY') if not private_key_hex: print("Error: APTOS_PRIVATEKEY is missing in .env file.") return account = Account.load_key(bytes.fromhex(private_key_hex[2:] if private_key_hex.startswith("0x") else private_key_hex)) rest_client = RestClient(NODE_URL) API_URL = "https://perps-tradeapi.kanalabs.io/addMargin" PARAMS = {"marketId": 1338, "tradeSide": True, "amount": 10} HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ int(payload_data["functionArguments"][0]), payload_data["functionArguments"][1].lower() == "true", int(payload_data["functionArguments"][2]), ] payload_data["argumentTypes"] = [ Serializer.u64, Serializer.bool, Serializer.u64 ] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Hash: {txn_hash}") except Exception as e: print(f"Transaction process error: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **26.** Get Net Profile Balance This endpoint returns the net profile balance, which includes both the available balance in trading account and any pending balances from closed positions on all markets. * **Endpoint URL**: [`https://perps-tradeapi.kanalabs.io/getNetProfileBalance`](https://perps-tradeapi.kanalabs.io/getNetProfileBalance) * **Method**: `GET` * **Query Parameters**: * `userAddress` (Required) - The wallet address for which the account balance is being fetched. **Example Request:** ``` GET https://perps-tradeapi.kanalabs.io/getNetProfileBalance?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Net Profile Balance fetched successfully", "data": 49443.432113 } ``` **Example Code to Fetch** Net Profile Balance **Information:** The following python demonstrates how to call the Get Net Profile Balance API using the `axios` library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getNetProfileBalance' params = { 'userAddress': '0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_net_profile_balance= response.json() print("getNetProfileBalance: ", get_net_profile_balance) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **27. Settle Pnl** This API returns a transaction payload used to manually (or automatically, on user interactions) refresh the user's position and settle the Pnl for a specific market, allowing the user to claim any unreleased Pnl. * **Endpoint URL**: [`https://perps-tradeapi.kanalabs.io/settlePnl`](https://perps-tradeapi.kanalabs.io/settlePnl) * **Method**: `GET` * **Query Parameters**: * **marketId** (Required) - * userAddress (Required) - **Example Request:** ``` GET https://perps-tradeapi.kanalabs.io/settlePnl?userAddress=0xd0ff27c8411015f386ffc464e3baaa12fca10f1bef1ec6af36c27ed96b65f6c6&marketId=1338=6000 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Update position payload built succesfully", "data": { "function": "0x732f891290449af5e9369866537a51a8e7dc566791aec61a468223ed840b1eb4::perpetual_scripts::update_position", "functionArguments": [ "0xd0ff27c8411015f386ffc464e3baaa12fca10f1bef1ec6af36c27ed96b65f6c6", "1338" ], "typeArguments": [] } } ``` **Example Code to Get Settle Pnl:** The following python demonstrates how to call the Get Settle pnl API using the `axios` library. ```python import asyncio import os from aptos_sdk.account import Account from aptos_sdk.async_client import RestClient from aptos_sdk.transactions import EntryFunction, TransactionArgument, TransactionPayload from aptos_sdk.bcs import Serializer from aptos_sdk.account_address import AccountAddress # Import this from aptos_sdk.type_tag import TypeTag, StructTag import requests from dotenv import load_dotenv from typing import Any, List load_dotenv() class AptosTransactionHandler: def __init__(self, rest_client: RestClient, account: Account): self.rest_client = rest_client self.account = account def fetch_payload(self, api_url, params, headers): try: response = requests.get(api_url, params=params, headers=headers) response.raise_for_status() return response.json().get("data") except requests.exceptions.RequestException as e: print(f"Error fetching payload: {e}") return None def create_transaction_function_arguments(self, arguments: List[Any], types: List[Serializer]) -> List[TransactionArgument]: if len(arguments) != len(types): raise ValueError("Arguments and types length mismatch.") return [TransactionArgument(arg, serializer) for arg, serializer in zip(arguments, types)] def create_transaction_payload(self, payload: dict) -> TransactionPayload: try: function_information = payload["function"].split("::") module = "::".join(function_information[:-1]) function_id = function_information[-1] function_arguments = self.create_transaction_function_arguments( payload["functionArguments"], payload["argumentTypes"] ) type_arguments = [TypeTag(StructTag.from_str(argument)) for argument in payload["typeArguments"]] entry_function = EntryFunction.natural( module=module, function=function_id, ty_args=type_arguments, args=function_arguments, ) return TransactionPayload(payload=entry_function) except Exception as e: print(f"Error creating transaction payload: {e}") raise async def submit_transaction(self, transaction_payload: TransactionPayload) -> str: try: signed_transaction_request = await self.rest_client.create_bcs_signed_transaction( sender=self.account, payload=transaction_payload ) txn_hash = await self.rest_client.submit_bcs_transaction( signed_transaction=signed_transaction_request ) await self.rest_client.wait_for_transaction(txn_hash=txn_hash) return txn_hash except Exception as e: print(f"Error during transaction submission: {e}") raise async def main(): NODE_URL = "https://api.testnet.aptoslabs.com/v1" rest_client = RestClient(NODE_URL) private_key_hex = os.getenv('APTOS_PRIVATEKEY') if private_key_hex.startswith("0x"): private_key_hex = private_key_hex[2:] private_key_bytes = bytes.fromhex(private_key_hex) account = Account.load_key(private_key_bytes) API_URL = "https://perps-tradeapi.kanalabs.io/settlePnl" PARAMS = { "userAddress":"0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770", "marketId": 1338 } HEADERS = {"x-api-key": os.getenv('API_KEY')} handler = AptosTransactionHandler(rest_client, account) payload_data = handler.fetch_payload(API_URL, PARAMS, HEADERS) if not payload_data: print("Failed to fetch payload data.") return try: payload_data["functionArguments"] = [ AccountAddress.from_str(payload_data["functionArguments"][0]), int(payload_data["functionArguments"][1]), ] payload_data["argumentTypes"] = [Serializer.struct, Serializer.u64] transaction_payload = handler.create_transaction_payload(payload_data) print("Transaction payload created successfully.") txn_hash = await handler.submit_transaction(transaction_payload) print(f"Transaction submitted successfully. Transaction hash: {txn_hash}") except Exception as e: print(f"Error during transaction process: {e}") if __name__ == "__main__": asyncio.run(main()) ``` ## **28.** Get Trade History * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getTradeHistory`](https://perps-tradeapi.kanalabs.io/getOrderHistory) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The wallet address to retrieve the trade history. * **marketId** (optional) - The ID of the market to filter the trade history. * offset (Optional) - The offset for paginating the results.\ limit (Optional) - The maximum number of results to return.\ order (Optional) - The sort order of the results. Accepts `asc` or `desc`. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getTradeHistory?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770&marketId=66 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched trade history successfully", "data": [ { "address": "0x556c6465f9cedfe721d0a8537cf898cd2e5881ef89eb4a5a39df62e6ca439087", "leverage": 2, "market_id": "14", "timestamp": 1745998772, "size": "1", "order_type": 2, "price": "5.37", "order_value": "5.37", "pnl": "-0.0026850000000000000558927906", "fee": "0.0026850000000000000558927906", "trade_id": "55340232221128654862", "last_updated": 1749419915, "transaction_version": 2665614406, "entry_price": null, "order_id": "55340232221128654848" }, { "address": "0x51f531abefc697845eabae4ba20c7cc26b1f849561bb016c4d90707c4ede1912", "leverage": 2, "market_id": "14", "timestamp": 1745998772, "size": "1", "order_type": 1, "price": "5.37", "order_value": "5.37", "pnl": "0", "fee": "0", "trade_id": "36893488147419103246", "last_updated": 1749419915, "transaction_version": 2665614406, "entry_price": null, "order_id": "36893628893497398522" } } ] ``` **Example Code to Fetch Trade History:** The following TypeScript/Node.js script demonstrates how to call the Get Trade History API using the `axios` library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getTradeHistory' params = { 'marketId': 501, 'userAddress': "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770" } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_trade_history = response.json() print("getTradeHistory: ", get_trade_history) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **29.** Get Deposit and Withdraw History * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getDepositAndWithdrawHistory`](https://perps-tradeapi.kanalabs.io/getDepositAndWithdrawHistory) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The wallet address to retrieve the order history **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getDepositAndWithdrawHistory?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770 Response: ``` * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched deposit and withdraw history successfully", "data": [ { "wallet_address": "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770", "address": "0xdf83209915c1b8087d8c2e3c1fe381f08fc7adbd55349a0bc9f4c906f8a76a82", "is_deposit": true, "timestamp": 1745236010, "amount": "10000", "last_updated": 1747110329, "transaction_version": 6694351099, "is_promoted": false, "promotion_id": null } ] } ``` **Example Code to Fetch Deposit and Withdraw History:** The following Python script demonstrates how to call the Get **Deposit and Withdraw History** API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getDepositAndWithdrawHistory' params = { 'userAddress': "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770" } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_deposit_and_withdraw_history= response.json() print("getDepositAndWithdrawHistory: ", get_deposit_and_withdraw_history) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **29.** Get Funding History * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getFundingHistory`](https://perps-tradeapi.kanalabs.io/getFundingHistory) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The wallet address to retrieve the funding history. * **marketId** (optional) - The ID of the market to filter the funding history. * offset (Optional) - The offset for paginating the results.\ limit (Optional) - The maximum number of results to return.\ order (Optional) - The sort order of the results. Accepts `asc` or `desc`. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getFundingHistory?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770 Response: ``` * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched funding history successfully", "data": [ { "address": "0xdf83209915c1b8087d8c2e3c1fe381f08fc7adbd55349a0bc9f4c906f8a76a82", "funding_amount": "0", "funding_rate": "0", "market_id": "1338", "funding_timestamp": 1748840400, "transaction_timestamp": 1748840428, "last_updated": 1748840431, "transaction_version": 6769626199, "trade_id": "83453070189462011512122", "size": "10", "leverage": 2, "trade_side": true } ] } ``` **Example Code to Fetch** Funding **History:** The following Python script demonstrates how to call the Get Funding **History** API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getFundingHistory' params = { 'userAddress': "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770" } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_funding_history= response.json() print("getFundingHistory: ", get_funding_history) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **30.** Fetch Order Status By Id * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/fetchOrderStatusById`](https://perps-tradeapi.kanalabs.io/fetchOrderStatusById) * **Method**:\ `GET` * **Query Parameters**: * **marketId** (Required) - The ID of the market associated with the order. * **orderId** (Required) - The unique identifier of the order to retrieve its status. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/fetchOrderStatusById?marketId=1338&orderId=33760566922324346434229328 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched final order status successfully", "data": { "address": "0x725c8b51b2c1b3d17336c48d75c56c19253f70e1de00e26c8138a29722d82da", "market_id": "1338", "leverage": 2, "order_type": 3, "timestamp": 1746216029, "is_market_order": false, "size": "0.218", "price": "5.20", "order_value": "1.13360", "status": "Cancelled", "order_id": "33760566922324346434229328", "trade_id": "172200355928078664336698", "last_updated": 1747229891, "transaction_version": 6704908886, "total_filled": "0.782", "remaining_size": "0.218", "total_trade_size": "1" } } ``` #### **Possible Order Status Values:** The `status` field will contain one of the following values: | Status | Meaning | | ------------------ | --------------------------------------------------------------------------------------------------------------- | | `Open` | Order is open | | `Filled` | The order is fully filled. There will be no remaining open orders with the same order ID in the order history | | `Partially Filled` | The order is partially filled. There will be remaining open orders with the same order ID in the order history. | | `Cancelled` | The order has been cancelled | **Example Code to Fetch** Order Status By Id**:** The following Python script demonstrates how to call the Fetch Order Status By Id API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/fetchOrderStatusById' params = { 'marketId': 501, 'orderId': '85703575078023708283016' } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() fetch_order_status_by_id= response.json() print("fetchOrderStatusById: ", fetch_order_status_by_id) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **31. Get Fills For Given Timestamp** * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getFillsForGivenTimestamp`](https://perps-tradeapi.kanalabs.io/getFillsForGivenTimestamp) * **Method**:\ `GET` * **Query Parameters**: userAddress (required) \ marketId (optional) \ offset (optional) \ limit (optional) —-> default 50 \ order (optional) —-> asc or desc \ fromTimestamp (optional) --> In seconds (not milliseconds) \ toTimestamp (optional) --> In seconds (not milliseconds) **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getFillsForGivenTimestamp?marketId=1340&userAddress=0xb37f565528dc7dc1ddb376e930b62002ab61361d8bb9bfc2b4ace661fc6dbbfa&fromTimestamp=1751366416&toTimestamp=1751426951 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched fill trades for a given time range Successfully", "data": [ { "address": "0x64e7e2d671526c2e092e5e7af94555c17c45d348400ae2a61424b6dbf338a9af", "leverage": 2, "market_id": "1340", "timestamp": 1751426951, "size": "1.0475", "order_type": 3, "price": "2449.50", "order_value": "2565.851250", "pnl": "0", "fee": "0", "trade_id": "245046548275157683668284", "last_updated": 1751426952, "transaction_version": 6798502405, "entry_price": null, "order_id": "112263471792402116758233007" }, { "address": "0x64e7e2d671526c2e092e5e7af94555c17c45d348400ae2a61424b6dbf338a9af", "leverage": 2, "market_id": "1340", "timestamp": 1751366695, "size": "0.9669", "order_type": 4, "price": "2470.10", "order_value": "2388.339690", "pnl": "0", "fee": "0", "trade_id": "32982778403792678290748", "last_updated": 1751366696, "transaction_version": 6798038058, "entry_price": null, "order_id": "112263490233376000689856637" } ] } ``` **Example Code to Get fills for given timestamp:** The following Python script demonstrates how to call the get fills for given timestamp API using the requests library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getFillsForGivenTimestamp' params = { 'userAddress': "0xd0ff27c8411015f386ffc464e3baaa12fca10f1bef1ec6af36c27ed96b65f6c6", 'fromTimestamp': 1751032488, 'toTimestamp': 1751032608 } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_fills_for_given_timestamp= response.json() print("getFillsForGivenTimestamp: ", get_fills_for_given_timestamp) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **32.** Get Positions From Contract * **Endpoint URL**: [`https://perps-tradeapi.kanalabs.io/getPositionsFromContract`](https://perps-tradeapi.kanalabs.io/getPositionsFromContract) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The wallet address of the user to view positions for. * **marketId** (optional) - The ID of the market to filter the positions. **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getPositionsFromContract?marketId=66&userAddress=0x2eda5777ed2bf68cbcc67359dd00ae5fa73b1d5fa160b7c3aeb42d748d485387 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched positions from contract successfully", "data": [ { "address": "0xef04eb57084fab57a42b7791d5e350240f890fc1c1cd12c2002cb93b86a7b564", "market_id": "14", "leverage": 10, "trade_side": true, "size": "1.76276", "available_order_size": "1.76276", "value": "9.53898961", "entry_price": "5.41139439884", "liq_price": "4.995", "margin": "0.953946706999278", "tp": "0", "sl": "0", "trade_id": "7667887236327365287084046" } ] } ``` **Example Code to Fetch** Open Position from contract**:** The following TypeScript/Node.js script demonstrates how to call the Get Open Position From Contract API using the `axios` library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getPositionsFromContract' params = { 'marketId': 501, 'userAddress': "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770" } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_open_position = response.json() print("getPositionsFromContract: ", get_open_position) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ``` ## **33.** Get Open Orders From Contract * **Endpoint URL**:\ [`https://perps-tradeapi.kanalabs.io/getOpenOrdersFromContract`](https://perps-tradeapi.kanalabs.io/getOpenOrdersFromContract) * **Method**:\ `GET` * **Query Parameters**: * **userAddress** (Required) - The wallet address to retrieve open orders for. * **marketId (Optional)** - The ID of the market to filter open orders. // Optional ``` Note : order_type Explanation: OPEN_LONG (1): Opens a new long position. OPEN_SHORT (2): Opens a new short position. INCREASE_LONG (3): Increases the size of an existing long position. INCREASE_SHORT (4): Increases the size of an existing short position. DECREASE_LONG (5): Reduces the size of an existing long position. DECREASE_SHORT (6): Reduces the size of an existing short position. CLOSE_LONG (7): Closes an existing long position. CLOSE_SHORT (8): Closes an existing short position. ``` **Example Request:** ```http GET https://perps-tradeapi.kanalabs.io/getOpenOrdersFromContract?userAddress=0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770&marketId=66 ``` **Example Response:** * **Status Code**: `200 OK` * **Response Body**: ```json { "success": true, "message": "Fetched open orders from contract successfully", "data": [ { "address": "0xef04eb57084fab57a42b7791d5e350240f890fc1c1cd12c2002cb93b86a7b564", "market_id": "14", "leverage": 10, "order_type": 3, "price": "5.459", "total_size": "1.69717", "remaining_size": "1.69717", "order_value": "9.26485103", "order_id": "220873897950436224634197331", "trade_id": "7667887236327365287084046" }, { "address": "0xef04eb57084fab57a42b7791d5e350240f890fc1c1cd12c2002cb93b86a7b564", "market_id": "14", "leverage": 10, "order_type": 3, "price": "5.448", "total_size": "1.69717", "remaining_size": "1.69717", "order_value": "9.24618216", "order_id": "220873916394787984380007752", "trade_id": "7667887236327365287084046" } ] } ``` **Example Code to Fetch** Open Orders From Contarct**:** The following TypeScript/Node.js script demonstrates how to call the Get Open Orders From Contract API using the `axios` library. ```python import os import requests from dotenv import load_dotenv load_dotenv() def main(): try: base_url = 'https://perps-tradeapi.kanalabs.io/getOpenOrdersFromContract' params = { 'marketId': 501, 'userAddress': "0x4d6dc68e391e86991e58ab4d548b7e92872430d1f51bc666fe0c206bad7ff770" } api_key = os.getenv('API_KEY') headers = { 'x-api-key': api_key } response = requests.get(base_url, params=params, headers=headers) response.raise_for_status() get_open_position = response.json() print("getOpenOrdersFromContract: ", get_open_position) except requests.exceptions.RequestException as error: print('An error occurred:', error) if __name__ == "__main__": main() ```