POSTPublicrandom-address-generate

Random Address Generator

Batch generate random mainland China addresses, including province, city, district, street number, and postal code. Supports filtering by province and city, generates up to 100 entries per request, suitable for test data population.

Usage Cost

1 coins/call

Try it online

Fire a real request right from your browser, no code required

Documentation

API Capabilities

This API is used to batch generate random mainland China address information. The generated address data structure is complete, including province, city, district, street number, postal code, and a complete concatenated address string. Developers can filter generated addresses by region by passing country, province, and city parameters to obtain random address data for specific areas.

Request and Response

Request parameters include the number to generate (count, up to 100 per request), country code (country, e.g., CN), province (province), and city (city). Upon successful API response, the data field will return an array of JSON objects. Each object contains fields such as province, city, district, street, zipCode, and full (full address), making it convenient for developers to parse and use directly.

Use Cases

Integration Examples

Includes ready-to-use Shell, Python, Go, Java, and PHP examples for direct integration.

Request Example

{
  "count": 5,
  "country": "CN",
  "province": "广东",
  "city": "深圳"
}

Response Example

{
  "code": "SUCCESS",
  "message": "success",
  "data": [
    {
      "province": "广东省",
      "city": "深圳市",
      "district": "南山区",
      "street": "科技路88号",
      "zipCode": "518000",
      "full": "广东省深圳市南山区科技路88号",
      "country": "CN"
    }
  ]
}

Request Fields

The fields below are derived from example JSON for integration reference only.

Path	Type	Sample
count	number	5
country	string	CN
province	string	广东
city	string	深圳

Response Fields

The fields below are derived from example JSON for integration reference only.

Path	Type	Sample
code	string	SUCCESS
message	string	success
data	array	{"province":"广东省","city":"深圳市","district":"南山区","street":"科技路88号","zipCode":"518000","full":"广东省深圳市南山区科技路88号","country":"CN"}
data[]	object	{...}
data[].province	string	广东省
data[].city	string	深圳市
data[].district	string

curl --request POST \ --url 'https://openapi.toolkk.com/v1/random-address-generate' \ --header 'Content-Type: application/json' \ --header 'X-API-Key: YOUR_API_KEY' \ --data '{\n "count": 5,\n "country": "CN",\n "province": "广东",\n "city": "深圳"\n}'

import os import requests url = "https://openapi.toolkk.com/v1/random-address-generate" payload = { "count": 5, "country": "CN", "province": "广东", "city": "深圳" } headers = { "Content-Type": "application/json", "X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"), } response = requests.request("POST", url, headers=headers, json=payload, timeout=30) response.raise_for_status() print(response.json())

package main import ( "bytes" "fmt" "io" "net/http" ) func main() { endpoint := "https://openapi.toolkk.com/v1/random-address-generate" payload := []byte("{\n \"count\": 5,\n \"country\": \"CN\",\n \"province\": \"广东\",\n \"city\": \"深圳\"\n}") req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload)) if err != nil { panic(err) } req.Header.Set("Content-Type", "application/json") req.Header.Set("X-API-Key", "YOUR_API_KEY") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() body, err := io.ReadAll(resp.Body) if err != nil { panic(err) } fmt.Println(string(body)) }

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class ToolkkExample { public static void main(String[] args) throws Exception { String payload = "{\n \"count\": 5,\n \"country\": \"CN\",\n \"province\": \"广东\",\n \"city\": \"深圳\"\n}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://openapi.toolkk.com/v1/random-address-generate")) .method("POST", HttpRequest.BodyPublishers.ofString(payload)) .header("Content-Type", "application/json") .header("X-API-Key", "YOUR_API_KEY") .build(); HttpResponse<String> response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } }

<?php $endpoint = 'https://openapi.toolkk.com/v1/random-address-generate'; $payload = "{\n \"count\": 5,\n \"country\": \"CN\",\n \"province\": \"广东\",\n \"city\": \"深圳\"\n}"; $ch = curl_init($endpoint); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Content-Type: application/json', 'X-API-Key: YOUR_API_KEY', ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); if ($response === false) { throw new RuntimeException(curl_error($ch)); } curl_close($ch); echo $response;

Random Address Generator

Try it online

Documentation

API Capabilities

Request and Response

Use Cases

Integration Examples

Request Example

Response Example

Request Fields

Response Fields

Usage Notes and Limitations

Shell Example

Python Example

Go Example

Java Example

PHP Example