API docs by Redocly

Road Traffic Volume (Pedestrians) API (v1.1)​​

Download OpenAPI specification:Download

You can obtain pedestrian traffic data (estimated number of pedestrians using roads) owned by GeoTechnologies, Inc., starting from January 2022.

Acquisition Target Latest available data
Month specification The month prior to the API usage date (from the second day of the month onwards)

Please see below for specific examples.

API usage date Acquisition Target Latest available data Remarks
2024年4月2日 Month specification March 2024 Data from the previous month can be retrieved starting from the second day of the month.
2024年5月1日 Month specification March 2024 Data for April 2024 is not yet available, therefore data for the previous month cannot be obtained
2024年5月2日 Month specification April 2024 Data from the previous month can be retrieved starting from the second day of the month.

Please note the following when using this API.

  • The latest data will be available after it is updated during the morning of the update day.
  • Roads for which sufficient GPS logs have not been collected to accurately estimate traffic volume are excluded from traffic volume estimation.
  • During periods when traffic volume falls below a certain level, the ratio of user attributes may not be displayed, and only traffic volume may be shown.
  • The road data used to estimate traffic volume is from the road network for automobiles. Traffic volume data is provided for roads such as shopping streets where vehicles can also use the roads depending on the time of day, but not for pedestrian-only areas such as train stations, underground shopping areas, and pedestrian overpasses.
  • Traffic volume is provided without distinguishing between the direction of pedestrian travel.
  • This API has a rate limit of 10 requests per second (total across all endpoints). When executing this API repeatedly, please wait until the response to the previous request has been returned before submitting the next request.
  • This API may be temporarily unavailable on Tuesdays around 1:30 AM to 2:30 AM due to system maintenance.
  • For this API, page views (PV) are counted as 1 for each API call.

Road traffic volume (pedestrians) API

Area API

Within a specified circular area and time period, the following is provided.

  • Road shape and its average traffic volume (people/hour)
  • Average hourly traffic volume (people/hour) for the entire area and average traffic ratio by user attribute.

The following uses are anticipated:

  • Graph the total traffic volume for the specified area and period.
  • The system displays road traffic volume for a specified area and period, along with the road's shape.
  • This process retrieves the road shape for a specified area and allows you to select the roads for which you want to graph traffic volume using the road API described later.
Authorizations:
api_key
query Parameters
center
required
string
Center coordinates of the search circle

Format

center=<longitude>,<latitude>
Please write the degree in the World Geodetic System (JGD2011) format.

Parameters Value
Longitude Floating-point numbers (100.0 to 160.0)
Latitude Floating-point numbers (0.0 to 66.0)

Input example

center=139.703360,35.69363
radius
required
integer [ 1 .. 1000 ]
Search radius (m)

Format

radius=<radius>

Input example

radius=1000
month
required
integer
Target month for acquisition

You can specify the date up to the month before the date of use.
The latest data will be available after it is updated during the morning of the 2nd of each month.
Example: If the usage date is April 15, 2024, you can specify up to 202403.

Format

month=YYYYMM

Input example

month=202310
day_of_week
string
Days of the week for acquisition

If not specified, all days of the week will be selected.

Format

day_of_week=<day of the week>
The days of the week you can choose are as follows:

Value Meaning
sun Sunday
mon Monday
tue Tuesday
wed Wednesday
thu Thursday
fri Friday
sat Saturday
week Weekdays (Monday, Tuesday, Wednesday, Thursday, Friday)
holi Holidays (Saturday and Sunday)
all All days of the week

Input example

day_of_week=week
time_range
string
Target time period

You can specify the search time in 3-hour increments. If not specified, the search will cover the entire time period (00:00-23:59).

Format

time_range=<start time range>,<end time range>
The following time slots are available:

Value Meaning
1 00:00-02:59
2 03:00-05:59
3 06:00-08:59
4 09:00-11:59
5 12:00-14:59
6 15:00-17:59
7 18:00-20:59
8 21:00-23:59

Input example

time_range=3,5

The above description searches for the period between 06:00 and 14:59.

header Parameters
x-api-key
required
string

Authentication is performed using an API key.
Please enter the API key provided by our company.

Responses

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "features": [
    ],
  • "properties": {
    }
}

Road api

We will provide the following for designated roads and designated periods:

  • The average hourly traffic volume (people/hour) and average traffic ratio by user attribute for roads specified by road link ID obtained via the Area API.

The following uses are anticipated:

  • Select the roads you want to graph from the roads obtained using the aforementioned road API, and then graph the traffic volume.
Authorizations:
api_key
query Parameters
link_id
required
string
Road link ID

Please specify the Road Link ID obtained from the Area API immediately before executing the Road API. Road Link IDs may change due to data updates; specifying an outdated Road Link ID may prevent you from retrieving data correctly.

Format

link_id=<road link ID>

Input example

link_id=12345
month
required
integer
Target month for acquisition

You can specify the date up to the month before the date of use.
The latest data will be available after it is updated during the morning of the 2nd of each month.
Example: If the usage date is April 15, 2024, you can specify up to 202403.

Format

month=YYYYMM

Input example

month=202310
day_of_week
string
Days of the week for acquisition

If not specified, all days of the week will be selected.

Format

day_of_week=<day of the week>
The days of the week you can choose are as follows:

Value Meaning
sun Sunday
mon Monday
tue Tuesday
wed Wednesday
thu Thursday
fri Friday
sat Saturday
week Weekdays (Monday, Tuesday, Wednesday, Thursday, Friday)
holi Holidays (Saturday and Sunday)
all All days of the week

Input example

day_of_week=week
time_range
string
Target time period

You can specify the search time in 3-hour increments. If not specified, the search will cover the entire time period (00:00-23:59).

Format

time_range=<start time range>,<end time range>
The following time slots are available:

Value Meaning
1 00:00-02:59
2 03:00-05:59
3 06:00-08:59
4 09:00-11:59
5 12:00-14:59
6 15:00-17:59
7 18:00-20:59
8 21:00-23:59

Input example

time_range=3,5

The above description searches for the period between 06:00 and 14:59.

header Parameters
x-api-key
required
string

Authentication is performed using an API key.
Please enter the API key provided by our company.

Responses

Response samples

Content type
application/json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

Change history

Date Content
2024年8月29日 - Added rate limits for this API.
- Added error response for when the rate limit is exceeded.