Skip to main content
POST
/
api
/
jalan
/
areas
/jalan/areas
curl --request POST \
  --url https://api.anysite.io/api/jalan/areas \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "timeout": 300,
  "prefecture": "130000",
  "large_area": "137100"
}
'
[
  {
    "id": "<string>",
    "name": "<string>",
    "url": "<string>",
    "@type": "@jalan_area",
    "prefecture_id": "<string>",
    "prefecture_name": "<string>",
    "large_area_id": "<string>",
    "large_area_name": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
prefecture
string | null

Prefecture to list large areas for, by Jalan prefecture code (e.g. 130000), Japanese name (e.g. 東京都) or area URL. Omit to list all 47 prefectures.

Example:

"130000"

large_area
string | null

Large area to list small areas for, by Jalan large-area code (e.g. 137100). Requires prefecture. Omit to list the prefecture's large areas.

Example:

"137100"

Response

Successful Response

id
string
required
name
string
required
level
enum<string>
required
Available options:
prefecture,
large_area,
small_area
url
string
required
@type
string
default:@jalan_area
prefecture_id
string | null
prefecture_name
string | null
large_area_id
string | null
large_area_name
string | null