Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: DTN Aviation Enhanced Flight Hazards (EFH) Turbulence API
description: The DTN Aviation Enhanced Flight Hazards (EFH) API retrieves available turbulence (including Nowcast), icing, high ice water content (HIWC), thunderstorms, ozone, jet stream axis, space weather, and Quantitative Volcanic Ash (QVA) data. Each data type has its own endpoint. Filtering parameters allow to limit data requests in various ways, particularly in limiting the area for which to find data.
version: 1.10.3
servers:
- url: https://aviation.api.dtn.com
security:
- clientCredentials: []
tags:
- name: Turbulence
description: On demand Turbulence via API
paths:
/v1/turbulence/:
get:
tags:
- Turbulence
summary: Get active Turbulence
description: Get all available Turbulence, potentially filtered by various query parameters. All specified filter parameters must be satisfied for an object to be returned in the response.
responses:
'200':
$ref: '#/components/responses/TurbulenceSuccess'
'400':
$ref: '#/components/responses/TurbulenceBadRequest'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
parameters:
- $ref: '#/components/parameters/QueryOffset'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryEfhFlightLevel'
- $ref: '#/components/parameters/QueryMinEdr'
- $ref: '#/components/parameters/QueryBbox'
- $ref: '#/components/parameters/QueryPolygon'
- $ref: '#/components/parameters/QueryCircle'
- $ref: '#/components/parameters/QueryCorridor'
- $ref: '#/components/parameters/QueryGeometry'
- $ref: '#/components/parameters/QueryConsolidate'
- $ref: '#/components/parameters/QuerySrid'
- $ref: '#/components/parameters/QueryDistanceUnits'
- $ref: '#/components/parameters/TurbulenceQueryIsValidAt'
- $ref: '#/components/parameters/TurbulenceQueryFromDateTime'
- $ref: '#/components/parameters/TurbulenceQueryUntilDateTime'
- $ref: '#/components/parameters/TurbulenceQueryInsertedAfter'
- $ref: '#/components/parameters/TurbulenceQueryInsertedThrough'
- $ref: '#/components/parameters/TurbulenceQueryModelDateTime'
- $ref: '#/components/parameters/QueryAllowPartialModelRun'
security:
- clientCredentials: []
components:
schemas:
Meta:
title: Meta
description: Meta data attached to every response
required:
- name
- request_id
- start_timestamp
- end_timestamp
- execution_time
type: object
properties:
name:
type: string
request_id:
type: string
start_timestamp:
type: integer
end_timestamp:
type: integer
execution_time:
type: integer
TurbulenceFeature:
description: GeoJSon 'Feature' object
externalDocs:
url: https://tools.ietf.org/html/rfc7946#section-3.2
allOf:
- $ref: '#/components/schemas/GeoJsonObject'
- type: object
required:
- geometry
- properties
properties:
geometry:
allOf:
- {}
- $ref: '#/components/schemas/Geometry'
properties:
$ref: '#/components/schemas/TurbulenceItem'
id:
oneOf:
- type: number
- type: string
TurbulenceFeatureCollection:
description: GeoJSon 'FeatureCollection' object
externalDocs:
url: https://tools.ietf.org/html/rfc7946#section-3.3
allOf:
- $ref: '#/components/schemas/GeoJsonObject'
- type: object
required:
- features
properties:
features:
type: array
items:
$ref: '#/components/schemas/TurbulenceFeature'
GeoJsonObject:
description: 'GeoJSon object The coordinate reference system for all GeoJSON coordinates is a geographic coordinate reference system, using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium (OGC) URN An OPTIONAL third-position element SHALL be the height in meters above or below the WGS 84 reference ellipsoid. In the absence of elevation values, applications sensitive to height or depth SHOULD interpret positions as being at local ground or sea level.
'
externalDocs:
url: https://tools.ietf.org/html/rfc7946#section-3
type: object
properties:
type:
type: string
enum:
- Feature
- FeatureCollection
- Point
- MultiPoint
- LineString
- MultiLineString
- Polygon
- MultiPolygon
- GeometryCollection
bbox:
description: 'A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
'
type: array
items:
type: number
required:
- type
discriminator:
propertyName: type
Geometry:
type: object
description: GeoJSon geometry
discriminator:
propertyName: type
required:
- type
externalDocs:
url: http://geojson.org/geojson-spec.html#geometry-objects
properties:
type:
type: string
enum:
- Point
- LineString
- Polygon
- MultiPoint
- MultiLineString
- MultiPolygon
description: the geometry type
TurbulenceItem:
type: object
required:
- validDateTime
- expirationDateTime
- insertedDateTime
- modelDateTime
- edr
- rid
properties:
validDateTime:
type: string
format: date-time
expirationDateTime:
type: string
format: date-time
insertedDateTime:
type: string
format: date-time
modelDateTime:
type: string
format: date-time
edr:
type: number
rid:
type: number
Error:
title: Error
description: Error
required:
- type
- title
- status
- detail
- meta
type: object
properties:
url:
type: string
type:
enum:
- internal-server-error
- unauthorized
- bad-request
- service-unavailable
- forbidden
- not-found
type: string
title:
type: string
status:
type: number
detail:
type: string
instance:
type: string
errors:
type: array
items:
type: object
meta:
$ref: '#/components/schemas/Meta'
parameters:
TurbulenceQueryInsertedAfter:
name: insertedAfter
description: UTC timestamp in format `YYYY-MM-DD hh:mm:ss.fff`. Limits to objects whose `insertedDateTime` is later than that specified value. This allows to acquire only data that became available after this time. Requires use of fractional seconds for full precision. A data insertion time value being accepted through this parameter does not mean there will be applicable data to return in response. Allowed values relative to the current time vary depending on the data type. For this data type, value must be no earlier than 18 hours in past and no later than current time.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}(\.\d+)?
TurbulenceQueryIsValidAt:
name: isValidAt
description: UTC timestamp in format `YYYY-MM-DD hh:mm:ss`. Limits to objects whose `validDateTime` is not earlier than the specified value and whose `expirationDateTime` is later than that specified value. A valid time value being accepted through this parameter does not mean there will be applicable data to return in response. Allowed values relative to the current time vary depending on the data type. For this data type, value must be no earlier than 18 hours in past and no later than 36 hours in future.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
TurbulenceQueryModelDateTime:
name: modelDateTime
description: UTC timestamp in format `YYYY-MM-DD hh:00:00`. Limits to objects whose `modelDateTime` (for model run time) is specifically the given value, overriding the default setting to provide data from the latest completely ingest model run. The `hh` must be one of `00`, `06`, `12`, or `18`, and date portion must be recent. Value must be no earlier than 24 hours ago (because only most recent 2 to 3 model runs may be available) no later than 3 hours ago (because model run data are not available until at least 3 hours after the run time). A model run time value being accepted through this parameter does not mean there will be applicable data to return in response. For this data type, value must be no earlier than 24 hours in past and no later than 3 hours in past.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
QueryMinEdr:
name: minEdr
description: Minimum EDR. Limits to objects whose `edr` value is greater than or equal to this.
in: query
required: false
schema:
type: number
minimum: 0.1
maximum: 0.9
default: 0.1
multipleOf: 0.1
QueryAllowPartialModelRun:
name: allowPartialModelRun
description: Boolean indicator for whether to allow partial model run data to be returned. If false (default), response data will be from latest completely ingested model run. If true, response data will come from the latest model run that can satisfy the set of request parameters even if that model run is not completely ingested and a different request may only be able to pull from earlier model run.
in: query
required: false
schema:
type: boolean
default: false
QueryLimit:
name: limit
description: Provide no more than this many items in the response set.
in: query
required: false
schema:
type: integer
default: 1000
minimum: 1
maximum: 10000
QueryCircle:
name: circle
description: Circle coordinates and radius distance in the format `<X>,<Y>,<RADIUS>`. The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default). The `<RADIUS>` defines the distance (in default or `distanceUnits`-specified units) from the defined point. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request. Requests with circle definition of area that crosses antimeridian will fail. The larger the defined area, the more its shape on projected map will differ from true circle on spherical coordinates. Maximum allowed <RADIUS> is 400nm (and equal lengths for different `distanceUnits`).
in: query
required: false
schema:
type: string
QueryBbox:
name: bbox
description: Bounding box coordinates in the format `<min_X>,<min_Y>,<max_X>,<max_Y>`. The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default). Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request. Requests with bbox definition of area that crosses antimeridian will fail.
in: query
required: false
schema:
type: string
TurbulenceQueryFromDateTime:
name: fromDateTime
description: UTC timestamp in format `YYYY-MM-DD hh:mm:ss`. Limits to objects whose `expirationDateTime` is later than that specified value, i.e., only objects not ended by this time. A time value being accepted through this parameter does not mean there will be applicable data to return in response. Allowed values relative to the current time vary depending on the data type. For this data type, value must be no earlier than 18 hours in past and no later than 36 hours in future.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
QueryPolygon:
name: polygon
description: Polygon coordinates in the format `<X_0>,<Y_0>,<X_1>,<Y_1>...,<X_n>,<Y_n>`. The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default). Must provide between 3 and 40 coordinates. If the last `X,Y` does not match the first `X,Y`, the first `X,Y` is copied to the end to close the polygon. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request. Requests with polygon definition of area that crosses antimeridian will fail or give unexpected results.
in: query
required: false
schema:
type: string
QueryEfhFlightLevel:
name: flightLevel
description: Specific flight level for EFH data. Must use only one of allowed values.
in: query
required: true
schema:
type: string
items:
type: string
enum:
- FL010
- FL030
- FL050
- FL080
- FL100
- FL120
- FL140
- FL160
- FL180
- FL200
- FL220
- FL240
- FL260
- FL270
- FL280
- FL300
- FL320
- FL330
- FL340
- FL350
- FL360
- FL370
- FL380
- FL390
- FL400
- FL410
- FL430
- FL450
- FL530
QueryOffset:
name: offset
description: Skip over this many into the response set; used for paginated results.
in: query
required: false
schema:
type: integer
default: 0
QueryConsolidate:
name: consolidate
description: Boolean indicator for merging GeoJSON Polygons objects into collective MultiPolygon objects. If true, areal objects sharing the same defining attributes (e.g., vertical velocity & top for thunderstorms or EDR for turbulence) are combined together into single MultiPolygon to minimize the number of distinct objects.
in: query
required: false
schema:
type: boolean
default: false
QueryGeometry:
name: geometry
description: Boolean indicator for inclusion of Geometry in response. If false, geometry will be returned empty.
in: query
required: false
schema:
type: boolean
default: true
TurbulenceQueryUntilDateTime:
name: untilDateTime
description: UTC timestamp in format `YYYY-MM-DD hh:mm:ss`. Limits to objects whose `validDateTime` is earlier than the specified value, i.e., only objects that began before this time. A time value being accepted through this parameter does not mean there will be applicable data to return in response. Allowed values relative to the current time vary depending on the data type. For this data type, value must be no earlier than 18 hours in past and no later than 36 hours in future.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
QuerySrid:
name: srid
description: SRID Identifier for coordinate system for spatial filter coordinates. Default is 4326 (i.e., ordinary longitude & latitude in degrees).
in: query
required: false
explode: false
schema:
type: integer
enum:
- 4326
- 3857
default: 4326
TurbulenceQueryInsertedThrough:
name: insertedThrough
description: UTC timestamp in format `YYYY-MM-DD hh:mm:ss.fff`. Limits to objects whose `insertedDateTime` is not later than that specified value. This allows to acquire only data that became available through this time. Requires use of fractional seconds for full precision. A data insertion time value being accepted through this parameter does not mean there will be applicable data to return in response. Allowed values relative to the current time vary depending on the data type. For this data type, value must be no earlier than 18 hours in past and no later than current time.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}(\.\d+)?
QueryCorridor:
name: corridor
description: Line coordinates and distance from the line in the format `<X_0>,<Y_0>,<X_1>,<Y_1>...,<X_n>,<Y_n>,<HALFWIDTH>`. The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default). Must provide between 2 and 40 coordinates for the line. The `<HALFWIDTH>` defines the distance (in default or `distanceUnits`-specified units) from the line defined by the coordinates out to which to create encompassing shape. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request. Requests with corridor definition of area that crosses antimeridian will fail or give unexpected results. The larger the defined area, the more its shape on projected map will differ from true corridor on spherical coordinates. Maximum allowed <HALFWIDTH> is 200nm (and equal lengths for different `distanceUnits`).
in: query
required: false
schema:
type: string
QueryDistanceUnits:
name: distanceUnits
description: Units identifier for distances in definition for circle or corridor spatial filter. Default is `nm` (nautical miles).
in: query
required: false
schema:
type: string
enum:
- nm
- km
- m
- sm
default: nm
responses:
ErrorUnauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unauthorized
title: Error while authenticating the user
status: 401
detail: Missing Authorization token.
instance: urn:dtn:aviation-api:/v1/notams/KIND:requestId:19e1b83a-cb2e-4460-b687-ce9d0c50b4b6
meta:
name: v1.notams.KIND
uuid: d64fc634-9bee-430d-8ab1-200337e6e9b2
request_id: 19e1b83a-cb2e-4460-b687-ce9d0c50b4b6
start_timestamp: 1714019217213
end_timestamp: 1714019217246
execution_time: 33
TurbulenceBadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
BadRequest:
$ref: '#/components/examples/TurbulenceBadRequestResponse'
TurbulenceSuccess:
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/TurbulenceFeatureCollection'
examples:
Success:
$ref: '#/components/examples/TurbulenceSuccessResponse'
examples:
TurbulenceBadRequestResponse:
value:
url: https://aviation.api.dtn.com/v1/turbulence/?flightLevel=FL290&bbox=-43,60,-40,63&isValidAt=2025-03-04%2019:45:00%20UTC
type: bad-request
title: Invalid Request
status: 400
detail: Validation failed.
instance: urn:dtn:aviation-api:/v1/turbulence/:requestId:f9207bc1-eb0f-4b4b-a8ac-e510df3de7d4
errors:
- message: '`flightLevel` for turbulence must be provided and one of specific set of 3-digit numbers formatted like `FL###` where `###` in (010|030|050|080|100|120|125|140|160|180|200|220|240|260|270|280|300|320|330|340|350|360|370|380|390|400|410|430|450|530)'
parameter: flightLevel
value: FL290
meta:
name: v1.turbulence.?flightLevel=FL290&bbox=-43,60,-40,63&isValidAt=2025-03-04%2019:45:00%20UTC
uuid: 4e591d8a-6afd-4153-b3dc-dae458c69ced
request_id: 61297f9d-b70b-4865-ae11-dd6027f662b2
start_timestamp: 1741112526576
end_timestamp: 1741112526835
execution_time: 259
TurbulenceSuccessResponse:
value:
url: https://aviation.api.dtn.com/v1/turbulence/?flightLevel=FL120&circle=-40,65,50&isValidAt=2025-03-03%2016:30:00%20UTC
type: FeatureCollection
features:
- type: Feature
geometry:
type: Polygon
coordinates:
- - - -41.375
- 65.375
- - -41.625
- 65.375
- - -41.625
- 65.4701769019185
- - -41.44122016145356
- 65.57123924312425
- - -41.375
- 65.59541562912416
- - -41.375
- 65.375
properties:
flightLevel: FL340
rid: 9939
edr: 0.1
validDateTime: '2025-05-07T20:00:00.000Z'
expirationDateTime: '2025-05-07T21:00:00.000Z'
insertedDateTime: '2025-05-07T16:01:38.625Z'
modelDateTime: '2025-05-07T12:00:00.000Z'
- type: Feature
geometry:
type: Polygon
coordinates:
- - - -41.875
- 65.125
- - -41.9431798631701
- 65.125
- - -41.941765377501824
- 65.13659692304464
- - -41.875
- 65.24695521598532
- - -41.875
- 65.125
properties:
flightLevel: FL340
rid: 9939
edr: 0.4
validDateTime: '2025-05-07T20:00:00.000Z'
expirationDateTime: '2025-05-07T21:00:00.000Z'
insertedDateTime: '2025-05-07T16:01:38.625Z'
modelDateTime: '2025-05-07T12:00:00.000Z'
- type: Feature
geometry:
type: Polygon
coordinates:
- - - -41.625
- 65.375
- - -41.625
- 65.125
- - -41.875
- 65.125
- - -41.875
- 65.24695521598532
- - -41.84627934813944
- 65.29442835595803
- - -41.75370866299289
- 65.375
- - -41.625
- 65.375
properties:
flightLevel: FL340
rid: 9939
edr: 0.1
validDateTime: '2025-05-07T20:00:00.000Z'
expirationDateTime: '2025-05-07T21:00:00.000Z'
insertedDateTime: '2025-05-07T16:01:38.625Z'
modelDateTime: '2025-05-07T12:00:00.000Z'
- type: Feature
geometry:
type: Polygon
coordinates:
- - - -41.125
- 65.125
- - -41.125
- 64.875
- - -41.375
- 64.875
- - -41.375
- 65.125
- - -41.125
- 65.125
properties:
flightLevel: FL340
rid: 9939
edr: 0.4
validDateTime: '2025-05-07T20:00:00.000Z'
expirationDateTime: '2025-05-07T21:00:00.000Z'
insertedDateTime: '2025-05-07T16:01:38.625Z'
modelDateTime: '2025-05-07T12:00:00.000Z'
- type: Feature
geometry:
type: Polygon
coordinates:
- - - -41.375
- 65.125
- - -41.375
- 64.625
- - -41.625
- 64.625
- - -41.625
- 65.125
- - -41.375
- 65.125
properties:
flightLevel: FL340
rid: 9939
edr: 0.1
validDateTime: '2025-05-07T20:00:00.000Z'
expirationDateTime: '2025-05-07T21:00:00.000Z'
insertedDateTime: '2025-05-07T16:01:38.625Z'
modelDateTime: '2025-05-07T12:00:00.000Z'
meta:
name: v1.turbulence.?flightLevel=FL340&isValidAt=2025-05-07T20:16:42.294Z&circle=-40,65,50
uuid: ca95958b-04a5-46fd-89bb-2d07dccfb5cc
request_id: 46656146-53e7-4385-a5c4-d7237bac2975
start_timestamp: 1746649002317
end_timestamp: 1746649015673
execution_time: 13356
securitySchemes:
clientCredentials:
type: oauth2
x-receive-token-in: request-body
flows:
clientCredentials:
tokenUrl: https://api.auth.dtn.com/v1/tokens/authorize
description: "# Using DAIS for M2M/API Auth\nYou have been given a Client ID and a Client Secret, which are used to request a DTN Access Token. DTN Access Tokens are required when making calls to each and every DTN API endpoint. The following information provides additional details on these tokens and how they are generated.\n## What is an Access Token and how is it different from an API Key?\nAn API Key is a random string of characters that an API uses to authorize whether or not a calling client has approved access to an endpoint. These keys are a non-standard approach to API authorization and are generally issued on a per-API basis.\n\nAn Access Token is also a string of characters but is a base-64 encoded JavaScript Object Notation Web Token, or JWT. JWTs are a widely accepted standard that use OAuth concepts and approaches. \n\nBoth API Keys and Access Tokens are used in an Authorization Request Header as a Bearer, meaning there is no difference in where you put this string of characters when you make calls to DTN APIs.\n## How to generate an Access Token?\nWhen requested, an Access Token is generated for your specific Client (ID/Secret) and for a specific API. The DTN Auth and Identity Service (DAIS) generates new Access Tokens for your client. The DAIS endpoint is `POST https://api.auth.dtn.com/v1/tokens/authorize`.\n\nThis endpoint takes two Header parameters:\n * `Content-Type: application/json`\n * `Accept: application/json`\n\nThis endpoint takes four parameters in the Request Body:\n * `grant_type`: this should always be client_credentials for generating machine-to-machine tokens.\n * `client_id`: this is the Client ID or Application ID using the token and is given to you by DTN's Identity Team. This ID will never change for your client/application.\n * `client_secret`: this is the Client Secret that is associated with the Application ID and is given to you by DTN's Identity Team. This key is subject to rotation for security purposes but always with the client's knowledge.\n * `audience`: this is the API for which this Access Token will be used. For the DTN Enhanced Flight Hazards API, you need to use the following audience: https://aviation.api.dtn.com\n\nYou can use this CURL command template as a reference for obtaining an access token:\n ```\n curl --location --request POST 'https://api.auth.dtn.com/v1/tokens/authorize' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"grant_type\": \"client_credentials\",\n\"client_id\": \"insert your client id here\",\n\"client_secret\": \"insert your client secret here\",\n\"audience\": \"insert your audience here\"\n}' \n ```\n\n*This document, for demonstration purposes, supplies a client_id and client_secret in all code examples. This client/application is for a fictitious API and cannot be used in practice to gain unauthorized access to any other DTN API.*\nUpon generating a new Access Token, you should receive an HTTP Response from DAIS similar to this:\n ```\n {\n \"data\": {\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw\",\n \"scope\": \"read:demo create:demo update:demo\",\n \"expires_in\": 90,\n \"token_type\": \"Bearer\"\n },\n \"meta\": {\n \"date_time\": \"2022-06-24T19:09:42.963Z\",\n \"name\": \"v1.tokens.authorize\",\n \"uuid\": \"ee6f9feb-dcf8-4421-a6fd-efd6beabdaa9\",\n \"start_timestamp\": 1656097782509,\n \"end_timestamp\": 1656097782963,\n \"execution_time\": 454\n }\n }\n ```\nLooking at this Response, you will see:\n * `access_token`: contains the JWT Access Token string you will use as your Bearer token.\n * `scope`: contains the scopes that this Access Token gives you permissions to access.\n * `expires_in`: contains the length of time before this Access Token will expire, in seconds.\n * `token_type`: verifies that this Access Token should be used as a Bearer token.\n\n## How to use an Access Token after one is generated?\nOnce a new Access Token is obtained, it is used in each call to a DTN API endpoint as a Bearer token in an Authorization Request Header. For example:\n ```\n Header: 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw'\n ```\n\n## Deconstructing the Access Token\nA DTN Access Token carries information within its JWT Body that is available on every API call. By deconstructing the JWT token, our Access Tokens will resemble:\n ```\n {\n \"https://auth.dtn.com/customerId\": \"1234567890Demo\",\n \"https://auth.dtn.com/productCode\": \"DemoApiP\",\n \"https://auth.dtn.com/requesterIp\": \"18.213.174.27\",\n \"https://auth.dtn.com/rps\": \"100\",\n \"https://auth.dtn.com/tier\": \"Basic\",\n \"https://auth.dtn.com/quota\": \"999999\",\n \"iss\": \"https://id.auth.dtn.com/\",\n \"sub\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM@clients\",
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dtn/refs/heads/main/openapi/dtn-turbulence-api-openapi.yml