Get Deposit Address - Aarc Documentation

cURL

curl --request GET \
  --url https://api.example.com/v3/deposit-address \
  --header 'x-api-key: <x-api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://api.example.com/v3/deposit-address', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/deposit-address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/deposit-address"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/deposit-address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "requestId": "<string>",
  "status": "<string>",
  "depositAddress": "<string>",
  "onChainID": "<string>",
  "depositTokenName": "<string>",
  "depositTokenSymbol": "<string>",
  "depositTokenAddress": "<string>",
  "depositTokenDecimals": "<string>",
  "depositTokenUsdPrice": 123,
  "amount": "<string>",
  "executionTime": "<string>",
  "gasFee": "<string>",
  "txData": {}
}

GET

/

v3

/

deposit-address

cURL

curl --request GET \
  --url https://api.example.com/v3/deposit-address \
  --header 'x-api-key: <x-api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://api.example.com/v3/deposit-address', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/deposit-address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/deposit-address"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/deposit-address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "requestId": "<string>",
  "status": "<string>",
  "depositAddress": "<string>",
  "onChainID": "<string>",
  "depositTokenName": "<string>",
  "depositTokenSymbol": "<string>",
  "depositTokenAddress": "<string>",
  "depositTokenDecimals": "<string>",
  "depositTokenUsdPrice": 123,
  "amount": "<string>",
  "executionTime": "<string>",
  "gasFee": "<string>",
  "txData": {}
}

Headers

x-api-key

string

required

Query Parameters

destinationChainId

string

required

destinationTokenAddress

string

required

toAmount

string

required

destinationRecipient

string

required

transferType

enum<string>

required

Available options:

onramp,

cex,

wallet

routeType

enum<string>

Available options:

time,

fee,

value

fromChainId

string

fromTokenAddress

string

fromAddress

string

slippage

string

transferOut

object[]

Show child attributes

targetCalldata

string

gasLimit

string

Response

200 - application/json

Deposit address details

requestId

string

status

string

depositAddress

string

onChainID

string

depositTokenName

string

depositTokenSymbol

string

depositTokenAddress

string

depositTokenDecimals

string

depositTokenUsdPrice

number

amount

string

executionTime

string

gasFee

string

txData

object