API docs by Redocly

Road traffic (vehicles) API (v1.1)​​

Download OpenAPI specification:Download

You can obtain vehicle traffic data (estimated number of vehicles (including motorcycles) traveling on roads) owned by GeoTechnologies, Inc., starting from January 2022.

Acquisition Target Latest available data
Date specified Two days prior to the API usage date
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
2023年10月2日 Date specified 2023年9月30日
2023年10月2日 Month specification September 2023 Data from the previous month can be retrieved starting from the second day of the month.
2023年11月1日 Date specified 2023年10月30日
2023年11月1日 Month specification September 2023 Data for October 31st is unavailable, therefore data for October cannot be obtained.
2023年11月2日 Date specified 2023年10月31日
2023年11月2日 Month specification October 2023 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.
  • Roads designated as "narrow streets" (roads with a strong function as roadside residential areas, such as local streets, or narrow roads where it is difficult for regular cars to pass each other, making them unsuitable for traffic guidance) in our data are excluded from traffic volume estimation.
  • Even when vehicles are traveling at low speeds due to traffic congestion, they are still included in the traffic volume estimation.
    *We independently extract and include logs from automobiles (including motorcycles) in our data collection.
  • 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 (vehicles) API

Area API

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

  • Road shape and average traffic volume (vehicles/hour) by direction (up and down lanes)
  • Average hourly traffic volume (vehicles/hour) for the entire area and average traffic ratio by user attribute (including passengers as well as drivers)

The following uses are anticipated:

  • Graph the total traffic volume for the specified area and period.
  • This displays road traffic volume for each direction (up and down lanes) within a specified area and period, along with the road shape.
  • This retrieves the road shape for each direction (up and down lanes) within a specified area, allowing 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 .. 2000 ]
Search radius (m)

Format

radius=<radius>

Input example

radius=2000
month
integer
Target month for acquisition

You must specify either the month or the date.
You cannot specify both month and date at the same time.

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 August 15, 2023, you can specify up to 202307.

Format

month=YYYYMM

Input example

month=202210
date
integer
Date of acquisition

You must specify either the month or the date.
You cannot specify both month and date at the same time.

You can specify the date up to two days before the date of use.
The latest data will be available after it is updated during the morning hours each day.
Example: If the usage date is August 15, 2023, you can specify dates up to 20230813.

Format

date=YYYYMMDD

Input example

date=20221001
day_of_week
string
Days of the week for acquisition

This can only be specified when a case is specified.
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.

offset
integer [ 0 .. 10 ]
Road shape offset distance (m)

For roads defined in our data maintenance system as “bidirectional single-lane roads,” road geometries can be obtained at positions offset to the left of the travel direction by a specified distance parameter, enabling traffic volume to be plotted separately for each direction (both directions).
If not specified, the distance will be 0m.

"Roads that are only passable in one direction" (such as highway main lines, two-lane roads where the lanes are physically separated by a median, and one-way roads) will not be offset even if this parameter is specified.

This parameter is intended to be set according to the map's display scale to achieve optimal visual appearance.
It is also possible to draw the upper and lower lines separately at an arbitrary offset distance on the client side without specifying this parameter.

Format

offset = <distance>

Input example

offset=5
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
Example
{
  • "type": "FeatureCollection",
  • "features": [
    ],
  • "properties": {
    }
}

Road api

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

  • The average traffic volume (vehicles/hour) and average pedestrian ratio by user attribute (including passengers as well as drivers) 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 IDs by direction (up and down lanes)

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
integer
Target month for acquisition

You must specify either the month or the date.
You cannot specify both month and date at the same time.

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 August 15, 2023, you can specify up to 202307.

Format

month=YYYYMM

Input example

month=202210
date
integer
Date of acquisition

You must specify either the month or the date.
You cannot specify both month and date at the same time.

You can specify the date up to two days before the date of use.
The latest data will be available after it is updated during the morning hours each day.
Example: If the usage date is August 15, 2023, you can specify dates up to 20230813.

Format

date=YYYYMMDD

Input example

date=20221001
day_of_week
string
Days of the week for acquisition

This can only be specified when a case is specified.
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.

offset
integer [ 0 .. 10 ]
Road shape offset distance (m)

For roads defined in our data maintenance system as “bidirectional single-lane roads,” road geometries can be obtained at positions offset to the left of the travel direction by a specified distance parameter, enabling traffic volume to be plotted separately for each direction (both directions).
If not specified, the distance will be 0m.

"Roads that are only passable in one direction" (such as highway main lines, two-lane roads where the lanes are physically separated by a median, and one-way roads) will not be offset even if this parameter is specified.

This parameter is intended to be set according to the map's display scale to achieve optimal visual appearance.
It is also possible to draw the upper and lower lines separately at an arbitrary offset distance on the client side without specifying this parameter.

Format

offset = <distance>

Input example

offset=5
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
Example
{
  • "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.