Smartmaps Timezone API Reference

Endpoints

Get Current Timezone at a Point

Retrieves current timezone data for a specific geographic point.

GET /api/v1/timezone/current/point

Parameters:

Name	Required	Type	Description
Longitude	Yes	number (double)	Longitude of the point
Latitude	Yes	number (double)	Latitude of the point
ApiKey	Yes	string	API key for authentication
IsoLocale	No	string	ISO locale for formatting
DateTimeFormat	No	string	Custom date-time format
Details	No	array of DetailRequestOptions	Additional details to include

Response:

• 200 OK: Returns a FeatureCollection object containing the timezone data.

Get Current Timezone for Multiple Points

Retrieves current timezone data for multiple geographic points.

POST /api/v1/timezone/current/point

Request Body:

Property	Type	Required	Description
apiKey	string	Yes	API key for authentication
isoLocale	string	No	ISO locale for formatting
dateTimeFormat	string	No	Custom date-time format
details	array of DetailRequestOptions	No	Additional details to include
points	array of Point	Yes	Array of points to query

Response:

• 200 OK: Returns a FeatureCollection object containing the timezone data.

Convert Timezone for a Point

Converts timezone data for a specific geographic point and date-time.

GET /api/v1/timezone/convert/point

Parameters:

Name	Required	Type	Description
DateTime	No	string (date-time)	Date and time to convert
TimeZoneId	No	string	Target timezone ID
Longitude	Yes	number (double)	Longitude of the point
Latitude	Yes	number (double)	Latitude of the point
ApiKey	Yes	string	API key for authentication
IsoLocale	No	string	ISO locale for formatting
DateTimeFormat	No	string	Custom date-time format
Details	No	array of DetailRequestOptions	Additional details to include

Response:

• 200 OK: Returns a FeatureCollection object containing the converted timezone data.

Convert Timezone for Multiple Points

Converts timezone data for multiple geographic points and date-times.

POST /api/v1/timezone/convert/point

Request Body:

Property	Type	Required	Description
apiKey	string	Yes	API key for authentication
isoLocale	string	No	ISO locale for formatting
dateTimeFormat	string	No	Custom date-time format
details	array of DetailRequestOptions	No	Additional details to include
points	array of Point	Yes	Array of points to convert
dateTime	string (date-time)	Yes	Date and time to convert
timeZoneId	string	No	Target timezone ID

Response:

• 200 OK: Returns a FeatureCollection object containing the converted timezone data.

Data Models

ConvertPointsRequest

Property	Type	Required	Description
apiKey	string	Yes	API key for authentication
isoLocale	string	No	ISO locale for formatting
dateTimeFormat	string	No	Custom date-time format
details	array of DetailRequestOptions	No	Additional details to include
points	array of Point	Yes	Array of points to convert
dateTime	string (date-time)	Yes	Date and time to convert
timeZoneId	string	No	Target timezone ID

CurrentPointsRequest

Property	Type	Required	Description
apiKey	string	Yes	API key for authentication
isoLocale	string	No	ISO locale for formatting
dateTimeFormat	string	No	Custom date-time format
details	array of DetailRequestOptions	No	Additional details to include
points	array of Point	Yes	Array of points to query

Point

Property	Type	Required	Description
longitude	number (double)	Yes	Longitude of the point
latitude	number (double)	Yes	Latitude of the point

DetailRequestOptions

Enum: ["SUN"] for information about sunset and sunrise.

Feature

GeoJSON Feature object containing timezone information.

FeatureCollection

GeoJSON FeatureCollection object containing multiple Feature objects with timezone information.

Swagger

For more detailed information on the response structures and additional models, please refer to the full Swagger documentation.