Validate an address

Confirms that a specified address is valid for a given token on a certain blockchain.

POST /v1/w3s/transactions/validateAddress

Validate an address

cURL

curl --request POST \
  --url https://api.circle.com/v1/w3s/transactions/validateAddress \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
  "blockchain": "MATIC-AMOY"
}
'

import requests

url = "https://api.circle.com/v1/w3s/transactions/validateAddress"

payload = {
    "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
    "blockchain": "MATIC-AMOY"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: '0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350',
    blockchain: 'MATIC-AMOY'
  })
};

fetch('https://api.circle.com/v1/w3s/transactions/validateAddress', 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.circle.com/v1/w3s/transactions/validateAddress",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => '0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350',
    'blockchain' => 'MATIC-AMOY'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.circle.com/v1/w3s/transactions/validateAddress"

	payload := strings.NewReader("{\n  \"address\": \"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350\",\n  \"blockchain\": \"MATIC-AMOY\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.circle.com/v1/w3s/transactions/validateAddress")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350\",\n  \"blockchain\": \"MATIC-AMOY\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.circle.com/v1/w3s/transactions/validateAddress")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350\",\n  \"blockchain\": \"MATIC-AMOY\"\n}"

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

200

{
  "data": {
    "isValid": true
  }
}

{
  "code": 123,
  "message": "<string>"
}

{
  "code": 401,
  "message": "Malformed authorization."
}

Authorizations

Authorization · string · header · required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request.

Body

application/json

Validate address request

address · string · required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

blockchain · enum<string> · required

The blockchain network that the resource is to be created on or is currently on.

Available options: ETH, ETH-SEPOLIA, AVAX, AVAX-FUJI, MATIC, MATIC-AMOY, SOL, SOL-DEVNET, ARB, ARB-SEPOLIA, NEAR, NEAR-TESTNET, EVM, EVM-TESTNET, UNI, UNI-SEPOLIA, BASE, BASE-SEPOLIA, OP, OP-SEPOLIA, APTOS, APTOS-TESTNET, ARC-TESTNET, MONAD, MONAD-TESTNET

Example:

"MATIC-AMOY"

Response

200

application/json

Address validated

data · object · required

Show child attributes