Transaction

Connect to Treehouse's Transaction WebSocket API

Creating a Socket Connection

A WebSocket connection should be made with the Treehouse service at wss://wss.treehouse.finance/by adding a valid API key to the headers: X-API-Key: {Your_API_Key}.

A successful connection will receive a response object when the connection is established. Here is an example of the response:

Status Code: 101 Switching Protocols
upgrade: websocket
connection: Upgrade
sec-websocket-accept: 34Aa+LCsEtjdWnzo5V8UgaJ+tE0=
date: Thu, 03 Aug 2023 16:59:50 GMT
server: istio-envoy

Subscriptions

Once a connection has been made with the WebSocket, you can subscribe to receive ETH and AVAX transactions sent or received by a wallet address:

{
  "event_data": {
    "0x28c6c06298d514db089934071355e5743bf21d60": [
      "eth",
      "avax"
    ],
    // ... other wallets subscribed to the transaction channel
  },
  "event_name": "subscribe-transaction-channel"
}

To update a request to subscribe to more or fewer wallet addresses and chains, update event_data accordingly and send another request message to the WebSocket.

To unsubscribe from the transaction channel, send a request message with the following:

{
  "event_name": "unsubscribe-transaction-channel"
}

Transaction

GET wss://wss.treehouse.finance/

Query Parameters

Name	Type	Description
event_data*	Object	Object specifying the wallet address and chain being subscribed to
wallet*	Object	Object specifying the chain the wallet is being subscribed to
event_name*	String	To specify a subscription or unsubscription to the transaction channel

200: OK Successfully unsubscribed to channel

{
    "code": 0,
    "msg_key": "_SUCCESS_",
    "msg": "You have successfully unsubscribed channel",
    "event_name": "unsubscribe-channel",
    "event_data": []
}

200: OK Successfully subscribed to channel

{
    "code": 0,
    "msg_key": "_SUCCESS_",
    "msg": "",
    "event_name": "subscribe-transaction-channel",
    "event_data": {
        "block": 17857747,
        "chain": "eth",
        "date": "2023-08-06 18:37:23 +0000 UTC",
        "details": [
            {
                "address": "0x95ad61b0a150d79219dcf64e1e6cc01f0b64c4ce",
                "amount": 12134816.29334265,
                "decimal": 18,
                "price": 0.00000936,
                "symbol": "SHIB",
                "type": "OUTFLOW"
            }
        ],
        "from": "0xf89d7b9c864f589bbf53a82105107622b35eaa40",
        "from_type": "Wallet",
        "gas_fee": 0.0011337497147458,
        "method_id": "0x0xa9059c",
        "protocol": "",
        "to": "0x95ad61b0a150d79219dcf64e1e6cc01f0b64c4ce",
        "to_type": "Wallet",
        "txn_fee_usd": 2.0766099900198496,
        "txn_hash": "0x98d3c9e281c0245d08a16cb47a211a5aeb8809dfd425c1c915e30d10cd4cafd8",
        "wallet": "0xf89d7b9c864f589bbf53a82105107622b35eaa40"
    }
}