DeepLink

DApps and H5 pages can launch the TronLink App to open the wallet, log in, make transfers, sign transactions, open DApps in the wallet, and more via DeepLink.

TronLink App DeepLink overview

For every action below, the param value of tronlinkoutside://pull.activity?param={} is the protocol data in JSON format. Note: the JSON string must be URL-encoded before being placed in the link.

Open Wallet

Launch TronLink wallet via DeepLink

Available since TronLink v4.10.0.

<a href='tronlinkoutside://pull.activity?param={}'>Open Tronlink</a>

param (request):

{
  "action": "open",
  "protocol": "TronLink",
  "version": "1.0"
}

Open DApp

Use DeepLink to launch TronLink and open DApp in the DApp Explorer

Available since TronLink v4.10.0.

<a href='tronlinkoutside://pull.activity?param={}'>Open DApp</a>

param (request) — url is the target DApp:

{
  "url": "https://www.tronlink.org/",
  "action": "open",
  "protocol": "TronLink",
  "version": "1.0"
}

Available since TronLink v4.11.0.

<a href='tronlinkoutside://pull.activity?param={}'>Login/Request Address</a>

param (request):

{
  "url": "https://justlend.org/#/home",
  "callbackUrl": "https://your-backend.example.com/api/tron/v1/callback",
  "dappIcon": "https://your-dapp.example.com/icon.png",
  "dappName": "Test demo",
  "protocol": "TronLink",
  "version": "1.0",
  "chainId": "0x2b6653dc",
  "action": "login",
  "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288"
}

Callback:

{
  "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288",
  "address": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig",
  "code": 0,
  "id": 1780812177,
  "message": "success"
}

Transfer

Available since TronLink v4.11.0.

<a href='tronlinkoutside://pull.activity?param={}'>Transfer</a>

param (request):

{
  "url": "https://justlend.org/#/home",
  "callbackUrl": "https://your-backend.example.com/api/tron/v1/callback",
  "dappIcon": "https://your-dapp.example.com/icon.png",
  "dappName": "Test demo",
  "protocol": "TronLink",
  "version": "1.0",
  "chainId": "0x2b6653dc",
  "memo": "Reward",
  "from": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig",
  "to": "TXd9duqtcyyj4pBCKvXKNqmazxxDw5SdBa",
  "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig",
  "tokenId": "0",
  "contract": "",
  "amount": "20",
  "action": "transfer",
  "actionId": "408170fc-7919-4459-be5e-05a9d4b4065e"
}

Callback (actionId matches the request):

{
  "actionId": "408170fc-7919-4459-be5e-05a9d4b4065e",
  "code": 0,
  "id": 1142367107,
  "message": "success",
  "transactionHash": "e8ffe9b92c771e66999732b810bf2493be389464191040d8666a26dc449fa5f0"
}

Sign Transaction

Available since TronLink v4.11.0.

<a href='tronlinkoutside://pull.activity?param={}'>Sign transaction</a>

param (request):

{
  "url": "https://justlend.org/#/home",
  "callbackUrl": "https://your-backend.example.com/api/tron/v1/callback",
  "dappIcon": "https://your-dapp.example.com/icon.png",
  "dappName": "Test demo",
  "protocol": "TronLink",
  "version": "1.0",
  "chainId": "0x2b6653dc",
  "action": "sign",
  "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig",
  "method": "transfer(address,uint256)",
  "signType": "signTransaction",
  "data": "{\"visible\":false,\"txID\":\"dcfaf2c2d75d91994f9a23623e905eaa7d74bc804fa5821640111ada3441376a\",\"raw_data\":{\"contract\":[{\"parameter\":{\"value\":{\"data\":\"a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c60200000000000000000000000000000000000000000000000000000000000000014\",\"owner_address\":\"41b42b84bad413dde093e27d01bb02ed9eede52c43\",\"contract_address\":\"41eca9bc828a3005b9a3b909f2cc5c2a54794de05f\"},\"type_url\":\"type.googleapis.com/protocol.TriggerSmartContract\"},\"type\":\"TriggerSmartContract\"}],\"ref_block_bytes\":\"84e1\",\"ref_block_hash\":\"1731d6450e11a03f\",\"expiration\":1670168865000,\"fee_limit\":100000000,\"timestamp\":1670168805340},\"raw_data_hex\":\"0a0284e122081731d6450e11a03f40e8d1c9eecd305aae01081f12a9010a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412740a1541b42b84bad413dde093e27d01bb02ed9eede52c43121541eca9bc828a3005b9a3b909f2cc5c2a54794de05f2244a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c6020000000000000000000000000000000000000000000000000000000000000001470dcffc5eecd30900180c2d72f\"}",
  "actionId": "64fcdb39-2cfa-47f2-85bd-d7e8409809ed"
}

Callback (actionId matches the request):

{
  "actionId": "64fcdb39-2cfa-47f2-85bd-d7e8409809ed",
  "code": 0,
  "id": -799302342,
  "message": "success",
  "successful": true,
  "transactionHash": "2fc49e560f648e5ecb455955d8778267ec1f257436425f62393b632c9a7a55ad"
}

Sign Message

Available since TronLink v4.11.0.

<a href='tronlinkoutside://pull.activity?param={}'>Sign message</a>

param (request):

{
  "url": "https://justlend.org/#/home",
  "callbackUrl": "https://your-backend.example.com/api/tron/v1/callback",
  "dappIcon": "https://your-dapp.example.com/icon.png",
  "dappName": "Test demo",
  "protocol": "TronLink",
  "version": "1.0",
  "chainId": "0x2b6653dc",
  "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig",
  "signType": "signStr",
  "message": "abc",
  "action": "sign",
  "actionId": "50554861-4861-41c4-adf3-abf36213f843"
}

Callback:

{
  "actionId": "50554861-4861-41c4-adf3-abf36213f843",
  "code": 0,
  "id": 2001871012,
  "message": "success",
  "signedData": "0xffcac5731d9f70a58e5126f44c34b9356ccb9bef53331e33ddab84bb829adc1b77df24362348f8d46e506b489b4af4496600799b173e708faf1b9db99da9d13c1b"
}

Result Code

Note: tokenId and contract are mutually exclusive in a transfer request — supplying both returns code 10025.

Code	Message
0	success
10001	Incorrect JSON format
10002	Missing Action
10003	Unknown Action
10004	Missing ActionId
10005	Incorrect DApp URL format
10006	Incorrect CallbackUrl format
10007	Empty DApp name
10008	Version number not supported
10009	Current network not supported
10010	The URL is not supported to open TronLink
10011	Unknown SignType
10012	Incorrect Transaction format
10013	Incorrect Method format
10014	Incorrect Message format
10015	Incorrect toAddress
10016	No wallet created in TronLink
10017	Incorrect fromAddress
10018	Incorrect contractAddress
10019	Incorrect chainId
10020	Incorrect amount
10021	The initiating address does not match the current wallet
10022	Incorrect loginAddress
10023	System contract not support
10024	Incorrect tokenId
10025	TokenId & Contract address should not exist together
300	Transaction canceled
301	Transaction executed in TronLink
302	Broadcast failure - returned with incorrect info
-1	Unknown reason

JSON Schema Reference

The param query value is a JSON object that — once URL-encoded — is the entire DeepLink contract. Schemas below follow JSON Schema Draft 7. The callback delivered to callbackUrl follows a small set of shapes keyed by action.

Common envelope

Every param shares this prefix:

{
  "type": "object",
  "required": ["action", "protocol", "version"],
  "properties": {
    "protocol":    { "type": "string", "const": "TronLink" },
    "version":     { "type": "string", "const": "1.0" },
    "action":      { "type": "string", "enum": ["open", "login", "transfer", "sign"] },
    "actionId":    { "type": "string", "description": "UUID v4 — required for any action that produces a callback (login, transfer, sign); the callback echoes the same actionId" },
    "url":         { "type": "string", "format": "uri", "description": "DApp URL — required for everything except 'open wallet'" },
    "callbackUrl": { "type": "string", "format": "uri", "description": "HTTPS endpoint that receives the JSON callback" },
    "dappName":    { "type": "string", "description": "DApp display name shown on the approval screen" },
    "dappIcon":    { "type": "string", "format": "uri", "description": "DApp icon URI shown on the approval screen" },
    "chainId":     { "type": "string", "enum": ["0x2b6653dc", "0x94a9059e", "0xcd8690dc"], "description": "Mainnet / Shasta / Nile (case-sensitive hex)" }
  }
}

Per-action schemas

Open wallet (no callback):

{
  "type": "object",
  "required": ["action", "protocol", "version"],
  "properties": {
    "action":   { "const": "open" },
    "protocol": { "const": "TronLink" },
    "version":  { "const": "1.0" }
  }
}

Open DApp in DApp Explorer (no callback):

{
  "type": "object",
  "required": ["action", "protocol", "version", "url"],
  "properties": {
    "action":   { "const": "open" },
    "protocol": { "const": "TronLink" },
    "version":  { "const": "1.0" },
    "url":      { "type": "string", "format": "uri" }
  }
}

Login request:

{
  "type": "object",
  "required": ["action", "actionId", "callbackUrl", "url", "protocol", "version"],
  "properties": {
    "action":      { "const": "login" },
    "actionId":    { "type": "string" },
    "url":         { "type": "string", "format": "uri" },
    "callbackUrl": { "type": "string", "format": "uri" },
    "dappName":    { "type": "string" },
    "dappIcon":    { "type": "string", "format": "uri" },
    "chainId":     { "type": "string" },
    "protocol":    { "const": "TronLink" },
    "version":     { "const": "1.0" }
  }
}

Login callback:

{
  "type": "object",
  "required": ["actionId", "code", "id", "message"],
  "properties": {
    "actionId": { "type": "string" },
    "code":     { "type": "integer", "description": "0 = success; see Result Code table for failure codes" },
    "id":       { "type": "integer", "description": "Internal request id (echoed for debugging)" },
    "message":  { "type": "string" },
    "address":  { "type": "string", "description": "Authorized TRON address (base58, T-prefix). Present only when code = 0." }
  }
}

Transfer request — tokenId (TRX / TRC10) and contract (TRC20) are mutually exclusive; supplying both returns 10025. Set the unused one to "" (empty string):

{
  "type": "object",
  "required": ["action", "actionId", "callbackUrl", "url", "from", "to", "loginAddress", "amount", "protocol", "version"],
  "properties": {
    "action":       { "const": "transfer" },
    "actionId":     { "type": "string" },
    "url":          { "type": "string", "format": "uri" },
    "callbackUrl":  { "type": "string", "format": "uri" },
    "from":         { "type": "string", "description": "Sender TRON address (base58)" },
    "to":           { "type": "string", "description": "Recipient TRON address (base58)" },
    "loginAddress": { "type": "string", "description": "Address that authorized this session — must match the current wallet (otherwise code 10021)" },
    "tokenId":      { "type": "string", "description": "TRC10 token id or '0' for TRX; pass '' when sending TRC20" },
    "contract":     { "type": "string", "description": "TRC20 contract address; pass '' when sending TRX / TRC10" },
    "amount":       { "type": "string", "description": "Decimal string in human units (e.g. '1.5'); the app handles decimals" },
    "memo":         { "type": "string", "description": "Optional transaction memo" },
    "dappName":     { "type": "string" },
    "dappIcon":     { "type": "string", "format": "uri" },
    "chainId":      { "type": "string" },
    "protocol":     { "const": "TronLink" },
    "version":      { "const": "1.0" }
  }
}

Transfer / sign-transaction callback:

{
  "type": "object",
  "required": ["actionId", "code", "id", "message"],
  "properties": {
    "actionId":        { "type": "string" },
    "code":            { "type": "integer" },
    "id":              { "type": "integer" },
    "message":         { "type": "string" },
    "successful":      { "type": "boolean", "description": "Only present for sign-transaction; reflects on-chain execution result" },
    "transactionHash": { "type": "string", "description": "64-char hex tx id; present when broadcast succeeded" }
  }
}

Sign transaction request — pass a fully-built TronWeb transaction in data (JSON string):

{
  "type": "object",
  "required": ["action", "actionId", "callbackUrl", "url", "loginAddress", "signType", "data", "protocol", "version"],
  "properties": {
    "action":       { "const": "sign" },
    "actionId":     { "type": "string" },
    "url":          { "type": "string", "format": "uri" },
    "callbackUrl":  { "type": "string", "format": "uri" },
    "loginAddress": { "type": "string" },
    "signType":     { "const": "signTransaction" },
    "method":       { "type": "string", "description": "Optional function selector for UI display, e.g. 'transfer(address,uint256)'" },
    "data":         { "type": "string", "description": "JSON-stringified TronWeb transaction (raw_data, raw_data_hex, txID, visible)" },
    "dappName":     { "type": "string" },
    "dappIcon":     { "type": "string", "format": "uri" },
    "chainId":      { "type": "string" },
    "protocol":     { "const": "TronLink" },
    "version":      { "const": "1.0" }
  }
}

Sign message request — signType controls the digest:

{
  "type": "object",
  "required": ["action", "actionId", "callbackUrl", "url", "loginAddress", "signType", "message", "protocol", "version"],
  "properties": {
    "action":       { "const": "sign" },
    "actionId":     { "type": "string" },
    "url":          { "type": "string", "format": "uri" },
    "callbackUrl":  { "type": "string", "format": "uri" },
    "loginAddress": { "type": "string" },
    "signType":     { "type": "string", "enum": ["signStr", "signTypedData"], "description": "signStr = signMessageV2 (TIP-191); signTypedData = TIP-712" },
    "message":      { "type": "string", "description": "Plain text or hex (signStr) / JSON-stringified typed-data domain+message (signTypedData)" },
    "dappName":     { "type": "string" },
    "dappIcon":     { "type": "string", "format": "uri" },
    "chainId":      { "type": "string" },
    "protocol":     { "const": "TronLink" },
    "version":      { "const": "1.0" }
  }
}

Sign message callback:

{
  "type": "object",
  "required": ["actionId", "code", "id", "message"],
  "properties": {
    "actionId":   { "type": "string" },
    "code":       { "type": "integer" },
    "id":         { "type": "integer" },
    "message":    { "type": "string" },
    "signedData": { "type": "string", "description": "0x-prefixed hex signature; present when code = 0" }
  }
}

Result code enum (callback `code`)

The full set of values is in the Result Code table above. Branch on code (integer), not on message (which is human-readable and may be localized).

DeepLink

Open Wallet

Launch TronLink wallet via DeepLink

Open DApp

Use DeepLink to launch TronLink and open DApp in the DApp Explorer

Login by TronLink

Transfer

Sign Transaction

Sign Message

Result Code

JSON Schema Reference

Common envelope

Per-action schemas

Result code enum (callback code)

Result code enum (callback `code`)