Skip to main content
POST
/
api
/
v2.1
/
fincard
/
virtual
/
common
/
v2
/
city
City List v2 (hierarchical)
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/common/v2/city \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-From: <x-forwarded-from>' \
  --data '
{
  "regionCode": "AU"
}
'
import requests

url = "https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/common/v2/city"

payload = { "regionCode": "AU" }
headers = {
"X-Forwarded-From": "<x-forwarded-from>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-Forwarded-From': '<x-forwarded-from>', 'Content-Type': 'application/json'},
body: JSON.stringify({regionCode: 'AU'})
};

fetch('https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/common/v2/city', 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://sandbox.finhub.cloud/api/v2.1/fincard/virtual/common/v2/city",
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([
'regionCode' => 'AU'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Forwarded-From: <x-forwarded-from>"
],
]);

$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://sandbox.finhub.cloud/api/v2.1/fincard/virtual/common/v2/city"

payload := strings.NewReader("{\n \"regionCode\": \"AU\"\n}")

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

req.Header.Add("X-Forwarded-From", "<x-forwarded-from>")
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://sandbox.finhub.cloud/api/v2.1/fincard/virtual/common/v2/city")
.header("X-Forwarded-From", "<x-forwarded-from>")
.header("Content-Type", "application/json")
.body("{\n \"regionCode\": \"AU\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/common/v2/city")

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

request = Net::HTTP::Post.new(url)
request["X-Forwarded-From"] = '<x-forwarded-from>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"regionCode\": \"AU\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "code": 123,
  "msg": "<string>",
  "data": [
    {
      "code": "<string>",
      "name": "<string>",
      "country": "<string>",
      "countryStandardCode": "<string>",
      "parentCode": "<string>",
      "children": [
        {
          "code": "<string>",
          "name": "<string>",
          "country": "<string>"
        }
      ]
    }
  ]
}

Headers

User-Agent
string

User agent

X-Forwarded-For
string

Forwarded for

X-Forwarded-From
string
required

Client application identifier

Example:

"client-app"

X-Tenant-ID
string

Tenant ID

deviceId
string

Device ID

platform
string

Platform

Body

application/json

City request with region code

City list request

regionCode
string

Country/Region code ISO 3166-1 alpha-2

Example:

"AU"

Response

Successful response

Hierarchical city response

success
boolean

Success flag

code
integer<int32>

Response code

msg
string

Response message

data
object[]

Hierarchical city data