Query postcode and suburb - Geckodistribution API

Request

Query Params

page

integer

required

Page number, counting from 1.

Example:

1

type

enum<string>

required

Search type.

Allowed values:

postcodesuburbcity

Example:

postcode

search

string

required

Postcode, suburb or city to be searched, supports fuzzy search.

Example:

6025

Header Params

version

string

required

接口版本号

Default:

token

string

required

接口Token

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://shopapi.geckodistribution.com/api/open/address/search?page=1&type=postcode&search=6025' \
--header 'version;' \
--header 'token;'

Responses

🟢200Success

application/json

Body

Success Response.

status

enum<string>

required

Response status code, typically uses 0 to indicate no exceptions, and non-zero values to indicate the presence of exceptions.

Allowed values:

0500

Example:

0

message

string

required

Exception response message, this field usually has significance when the value of status is non-zero.

Example:

Operation successful.

data

object | null

optional

Response data.

addresslist

array[object (OpenAddressVo) {3}]

optional

Address list

Example

{
    "status": "0",
    "message": "Operation successful.",
    "data": {
        "addresslist": [
            {
                "postcode": "6025",
                "suburb": "Kunune Park",
                "city": "Port Elizabeth"
            }
        ]
    }
}

🟢200Failure