---
updatedAt: 2026-09-15T08:24:16.000Z
agentTools:
  projectIndex: https://apidocs.bct.host/llms.txt
---

# Get Wallet Address (Legacy)

Get a valid wallet address to deposit cryptocurrency to your OSL account.

<Callout icon="⚠️" theme="warn">


  This endpoint has been superceded by [https://osl.com/reference/queryaddress.](https://osl.com/reference/queryaddress "https://osl.com/reference/queryaddress")  It will continue to be supported for the foreseeable future, but customers are recommended to develop against the new endpoint.
</Callout>

A new string field `network`has been added that serves as the chain network identifier, e.g. `ETHEREUM`, `TRON`, etc.

* **Request Parameters** has been updated to include `network` as an optional field for clients who have already merged.
* **Response Parameters** will now include `network` on all responses.

<br />

To identify which networks are available for a given currency, you can use the new [Get Supported Transfer Network](https://apidocs.bct.host/update/reference/getsupportedtransfernetwork) endpoint.

<br />

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "rest-v3",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://trade-hk.oslsandbox.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Rest-Key",
        "x-default": ""
      },
      "sec1": {
        "type": "apiKey",
        "in": "header",
        "name": "Rest-Sign"
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": []
    }
  ],
  "paths": {
    "/api/3/receive": {
      "post": {
        "summary": "Get Wallet Address (Legacy)",
        "description": "Get a valid wallet address to deposit cryptocurrency to your OSL account.",
        "operationId": "deposit-funds",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "tonce",
                  "ccy"
                ],
                "properties": {
                  "tonce": {
                    "type": "integer",
                    "description": "The current <<glossary:Unix time>> in microseconds.",
                    "format": "int64"
                  },
                  "ccy": {
                    "type": "string",
                    "description": "Crypto ticker (e.g. BTC, ETH)."
                  },
                  "accountGroupUuid": {
                    "type": "string",
                    "description": "To select which account group to display the address from."
                  },
                  "network": {
                    "type": "string",
                    "description": "Blockchain network identifier, e.g. `ETHEREUM`, `TRON`, etc. (use Get Supported Transfer Network for valid values)."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n   \"address\":\"2N31wefEoAtgnqzPEmKtrVyM196Ajtg8eyd\",\n   \"resultCode\":\"OK\",\n   \"subAccount\":\"fke94h41-1234-wefe-ba6b-7aa750a42fa7\",\n   \"timestamp\":\"1666602654963\"\n}"
                  },
                  "Invalid Parameters": {
                    "value": "{\n   \"resultCode\":\"INVALID_PARAMETERS\",\n   \"timestamp\":\"1666602288852\"\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "address": {
                          "type": "string",
                          "example": "2N31wefEoAtgnqzPEmKtrVyM196Ajtg8eyd"
                        },
                        "resultCode": {
                          "type": "string",
                          "example": "OK"
                        },
                        "subAccount": {
                          "type": "string",
                          "example": "fke94h41-1234-wefe-ba6b-7aa750a42fa7"
                        },
                        "timestamp": {
                          "type": "string",
                          "example": "1666602654963"
                        }
                      }
                    },
                    {
                      "title": "Invalid Parameters",
                      "type": "object",
                      "properties": {
                        "resultCode": {
                          "type": "string",
                          "example": "INVALID_PARAMETERS"
                        },
                        "timestamp": {
                          "type": "string",
                          "example": "1666602288852"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"timestamp\": \"1666418418989\",\n  \"resultCode\": \"UNAUTHORISED\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "example": "1666418418989"
                    },
                    "resultCode": {
                      "type": "string",
                      "example": "UNAUTHORISED"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"timestamp\": \"1666418418989\",\n  \"resultCode\": \"UNAUTHORISED\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "example": "1666418418989"
                    },
                    "resultCode": {
                      "type": "string",
                      "example": "UNAUTHORISED"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n   \"apiVersion\":\"1.0.0\",\n   \"error\":\"SYSTEM_ERROR\",\n   \"timestamp\":1666587269\n}\n"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "apiVersion": {
                      "type": "string",
                      "example": "1.0.0"
                    },
                    "error": {
                      "type": "string",
                      "example": "SYSTEM_ERROR"
                    },
                    "timestamp": {
                      "type": "integer",
                      "example": 1666587269,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "500",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n   \"resultCode\":\"SYSTEM_ERROR\",\n   \"timestamp\":\"1666580244296\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "resultCode": {
                      "type": "string",
                      "example": "SYSTEM_ERROR"
                    },
                    "timestamp": {
                      "type": "string",
                      "example": "1666580244296"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": true
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```