<section id="infinite-flight-connect-api-overview">
<h1><a class="header-anchor" href="#infinite-flight-connect-api-overview"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Infinite Flight Connect API Overview</h1>
<section class="reference">
<p>The Connect API is our local TCP API used for getting specific data and performing actions in-flight. Examples of this include:</p>
<ul>
<li>Turning Lights on/off</li>
<li>Controlling Autopilot</li>
<li>Controlling Network Joysticks</li>
</ul>
</section>
<section id="how-to-use-the-api">
<h2><a class="header-anchor" href="#how-to-use-the-api"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> How to use the API</h2>
<section class="reference">
<p>The Connect API comes in two versions - v1 and v2 - available on ports <code>10111</code> and <code>10112</code> respectively. Version 1 uses JSON objects as strings, whereas Version 2 uses a range of formats and has more functions.</p>
<p>To be able to use the Connect API, users must have it enabled. To do this, users can follow these steps.</p>
<dl>
<dt>Step 1</dt>
<dd>Open Infinite Flight</dd>
<dt>Step 2</dt>
<dd>Go into Settings &gt; General</dd>
<dt>Step 3</dt>
<dd>Scroll towards the bottom and look for 'Enable Infinite Flight Connect'</dd>
<dt>Step 4</dt>
<dd>Check the box if it is not checked alread</dd>
</dl>
<p>Keep in mind the Connect API is disabled by default.</p>
</section>
</section>
<section id="api-keys">
<h2><a class="header-anchor" href="#api-keys"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> API Keys</h2>
<section class="reference">
<p>No API Key is required for the Connect API.</p>
</section>
</section>
<section id="prerequisites">
<h2><a class="header-anchor" href="#prerequisites"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Prerequisites</h2>
<section class="reference">
<p>This documentation is aimed at someone with knowledge of:</p>
<ul>
<li>Transmission Control Protocol (TCP)</li>
<li>Data Types</li>
<li>JSON</li>
<li>Infinite Flight Operations</li>
</ul>
<p>If you are not knowledgeable in these areas, you are of course welcome to browse the documentation. You can also check out these resources to help you learn.</p>
<ul>
<li><a href="https://www.cloudflare.com/learning/ddos/glossary/tcp-ip/" class="documentation-content-link">What is TCP/IP? | Cloudflare</a></li>
<li><a href="https://www.w3schools.com/cs/cs_data_types.asp" class="documentation-content-link">W3Schools - C# Data Types</a></li>
<li><a href="https://www.w3schools.com/js/js_json_intro.asp" class="documentation-content-link">W3Schools - JSON Introduction</a></li>
<li><a href="/guide/flying-guide" class="documentation-content-link">Infinite Flight Flying Guide</a></li>
</ul>
</section>
</section>
</section>


Overview

<section id="connect-api-v1">
<h1><a class="header-anchor" href="#connect-api-v1"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Connect API v1</h1>
<section class="reference">
<p>This documentation is for Version 1 of the Connect API. Using this API is no longer recommended due to it's slow speed and limited features. See the <a href="/guide/developer-reference/connect-api/version-2" class="documentation-content-link">Version 2 Documentation</a> for more information.</p>
<blockquote>
<p><strong class="red">The Connect API v1 is being sunsetted and will be removed in update 23.1. See <a href="https://community.infiniteflight.com/t/important-sunsetting-connect-api-v1/753771" class="documentation-content-link">here</a> for further details.</strong></p>
</blockquote>
</section>
<section id="connection">
<h2><a class="header-anchor" href="#connection"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Connection</h2>
<section class="reference">
<ol>
<li>
<p>To enable Infinite Flight command server, check <strong>Enable Infinite Flight Connect</strong> in <strong>Settings &gt; General</strong></p>
</li>
<li>
<p>Infinite Flight will broadcast UDP packets on port <code>15000</code> containing its own IP address and Port. Example message: <code>{ &quot;Address&quot;: &quot;192.168.0.11&quot;, &quot;Port&quot;: 10111 }</code></p>
</li>
<li>
<p>You must then establish a TCP connection on this given host and port</p>
</li>
</ol>
</section>
</section>
<section id="get-airplane-state">
<h2><a class="header-anchor" href="#get-airplane-state"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Airplane State</h2>
<section class="reference">
<p>This special command will request the airplane state from Infinite Flight. Response will be received on the same socket: <code>{ &quot;Command&quot;: &quot;Airplane.GetState&quot;, &quot;Parameters&quot;: []}</code></p>
</section>
</section>
<section id="command-messages">
<h2><a class="header-anchor" href="#command-messages"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Command Messages</h2>
<section class="reference">
<p>A command message is a object of the following form :</p>
<p>There are two types of command messages:</p>
<ul>
<li>Commands: <code>{ &quot;Command&quot;: &quot;Commands.{CommandName}&quot;, &quot;Parameters&quot;: []}</code></li>
<li>Axis: <code>{ &quot;Command&quot;: &quot;NetworkJoystick.{AxisCommandName}&quot;, &quot;Parameters&quot;: []}</code></li>
</ul>
</section>
</section>
<section id="list-of-commands">
<h2><a class="header-anchor" href="#list-of-commands"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> List of commands</h2>
<section class="reference"></section>
<section id="joystick">
<h4><a class="header-anchor" href="#joystick"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Joystick</h4>
<section class="sample">
<p>Joystick axis use the <code>NetworkJoystick.SetAxisValue</code> command with two parameters:</p>
<ul>
<li>Axis Name: <code>0</code> for Roll, <code>1</code> for Pitch</li>
<li>Value: a value between <code>-1024</code> and <code>1024</code></li>
</ul>
<p>Example :</p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;NetworkJoystick.SetAxisValue&quot;,
  &quot;Parameters&quot;: [ { &quot;Name&quot;: 0, &quot;Value&quot;: -340 } ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="plane-systems">
<h4><a class="header-anchor" href="#plane-systems"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Plane Systems</h4>
<section class="sample">
<p>Commands to control various systems of the plane. For example, to lower flaps down:</p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;Commands.FlapsDown&quot;,
  &quot;Parameters&quot;: []
}
</code></pre>
</section>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Brakes</code></td>
<td>Toggle brakes on/off</td>
</tr>
<tr>
<td><code>ParkingBrakes</code></td>
<td>Toggle parking brakes</td>
</tr>
<tr>
<td><code>FlapsDown</code></td>
<td>Decrement flaps</td>
</tr>
<tr>
<td><code>FlapsUp</code></td>
<td>Increment flaps</td>
</tr>
<tr>
<td><code>FlapsFullDown</code></td>
<td>Set flaps full</td>
</tr>
<tr>
<td><code>FlapsFullUp</code></td>
<td>Set flaps clean</td>
</tr>
<tr>
<td><code>Aircraft.SetFlapState</code></td>
<td>Set the flaps to a given state</td>
</tr>
<tr>
<td><code>Spoilers</code></td>
<td>Switch between spoilers states (Off, Flight, Armed)</td>
</tr>
<tr>
<td><code>LandingGear</code></td>
<td>Toggle landing gear</td>
</tr>
<tr>
<td><code>Pushback</code></td>
<td>Toggle Pushback (on/off)</td>
</tr>
<tr>
<td><code>RollLeft</code></td>
<td>Roll the aircraft left</td>
</tr>
<tr>
<td><code>RollRight</code></td>
<td>Roll the aircraft right</td>
</tr>
<tr>
<td><code>PitchUp</code></td>
<td>Pitch the aircraft up</td>
</tr>
<tr>
<td><code>PitchDown</code></td>
<td>Pitch the aircraft down</td>
</tr>
<tr>
<td><code>ElevatorTrimUp</code></td>
<td>Trim elevator up</td>
</tr>
<tr>
<td><code>ElevatorTrimDown</code></td>
<td>Trim elevator down</td>
</tr>
<tr>
<td><code>ThrottleUpCommand</code></td>
<td>Throttle up by 2 or 3% (alternates)</td>
</tr>
<tr>
<td><code>ThrottleDownCommand</code></td>
<td>Throttle down by 2 or 3% (alternates)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="lights">
<h4><a class="header-anchor" href="#lights"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Lights</h4>
<section class="sample">
<p>Following commands toggle the state of a light. For example:</p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;Commands.LandingLights&quot;,
  &quot;Parameters&quot;: []
}
</code></pre>
</section>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>LandingLights</code></td>
<td>Toggle landing lights</td>
</tr>
<tr>
<td><code>StrobeLights</code></td>
<td>Toggle strobe lights</td>
</tr>
<tr>
<td><code>BeaconLights</code></td>
<td>Toggle beacon lights</td>
</tr>
<tr>
<td><code>NavLights</code></td>
<td>Toggle navigation lights</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="camera">
<h4><a class="header-anchor" href="#camera"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Camera</h4>
<section class="sample">
<p><strong>Camera Commands</strong></p>
<p>Following commands can be used to control cameras. For example:</p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;Commands.NextCamera&quot;,
  &quot;Parameters&quot;: []
}
</code></pre>
</section>
<section class="reference">
<p><em>For camera moves, see Axis commands below</em></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>ToggleHUD</code></td>
<td>Switch between HUD states (Full, Minimal, Map, Disabled)</td>
</tr>
<tr>
<td><code>NextCamera</code></td>
<td>Switch to next camera</td>
</tr>
<tr>
<td><code>PrevCamera</code></td>
<td>Switch to previous camera</td>
</tr>
<tr>
<td><code>CameraMoveLeft</code></td>
<td>Pan the camera left</td>
</tr>
<tr>
<td><code>CameraMoveRight</code></td>
<td>Pan the camera right</td>
</tr>
<tr>
<td><code>CameraMoveDown</code></td>
<td>Pan the camera down</td>
</tr>
<tr>
<td><code>CameraMoveUp</code></td>
<td>Pan the camera up</td>
</tr>
<tr>
<td><code>CameraMoveHorizontal</code></td>
<td>Move the camera horizontally</td>
</tr>
<tr>
<td><code>CameraMoveVertical</code></td>
<td>Move the camera vertically</td>
</tr>
<tr>
<td><code>CameraZoomIn</code></td>
<td>Zoom the camera in</td>
</tr>
<tr>
<td><code>CameraZoomOut</code></td>
<td>Zoom the camera out</td>
</tr>
<tr>
<td><code>SetCockpitCamera</code></td>
<td>Switch to the cockpit camera</td>
</tr>
</tbody>
</table></div><p><strong>Camera Axis</strong></p>
<p>Camera POV movements can be controlled via the following command:</p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;NetworkJoystick.SetPOVState&quot;,
  &quot;Parameters&quot;: [
    { &quot;Name&quot;: &quot;X&quot;, &quot;Value&quot;: 0 },
    { &quot;Name&quot;: &quot;Y&quot;, &quot;Value&quot;: 0 }
  ]
}
</code></pre>
<p>X and Y values can be either <code>-1</code>, <code>0</code> or <code>1</code>: they determine if the camera will move on each axis, either negatively or positively (or stay still on the given axis with the <code>0</code> value). For example, to move the POV to the left only horizontally, use the following command :</p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;NetworkJoystick.SetPOVState&quot;,
  &quot;Parameters&quot;: [
    { &quot;Name&quot;: &quot;X&quot;, &quot;Value&quot;: -1 },
    { &quot;Name&quot;: &quot;Y&quot;, &quot;Value&quot;: 0 }
  ]
}
</code></pre>
</section>
</section>
<section id="atc-(live-mode-only)">
<h4><a class="header-anchor" href="#atc-(live-mode-only)"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> ATC (Live Mode Only)</h4>
<section class="sample">
<p>Allows you to send messages to ATC according to the options available on the ATC window. Example, call the ATC command #3 (as shown on the ATC window) :</p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;Commands.ATCEntry3&quot;,
  &quot;Parameters&quot;: []
}
</code></pre>
</section>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>ShowATCWindowCommand</code></td>
<td>Show / Hide the ATC window</td>
</tr>
<tr>
<td><code>ATCEntry1</code></td>
<td>Choose option #1 (often back)</td>
</tr>
<tr>
<td><code>ATCEntry2</code></td>
<td>Choose option #2</td>
</tr>
<tr>
<td><code>ATCEntry3</code></td>
<td>Choose option #3</td>
</tr>
<tr>
<td><code>ATCEntry4</code></td>
<td>Choose option #4</td>
</tr>
<tr>
<td><code>ATCEntry5</code></td>
<td>Choose option #5</td>
</tr>
<tr>
<td><code>ATCEntry6</code></td>
<td>Choose option #6</td>
</tr>
<tr>
<td><code>ATCEntry7</code></td>
<td>Choose option #7</td>
</tr>
<tr>
<td><code>ATCEntry8</code></td>
<td>Choose option #8</td>
</tr>
<tr>
<td><code>ATCEntry9</code></td>
<td>Choose option #9</td>
</tr>
<tr>
<td><code>ATCEntry10</code></td>
<td>Choose option #10</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="autopilot-and-flight-plan">
<h4><a class="header-anchor" href="#autopilot-and-flight-plan"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Autopilot and Flight Plan</h4>
<section class="sample">
<p>Commands to set the value of an Autopilot param, or to toggle its state.</p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Autopilot.Toggle</code></td>
<td>Toggle autopilot</td>
</tr>
<tr>
<td><code>Autopilot.SetState</code></td>
<td>Set autopilot on/off</td>
</tr>
<tr>
<td><code>Autopilot.SetHeading</code></td>
<td>Set autopilot Heading</td>
</tr>
<tr>
<td><code>Autopilot.SetAltitude</code></td>
<td>Set autopilot Altitude</td>
</tr>
<tr>
<td><code>Autopilot.SetVS</code></td>
<td>Set autopilot Vertical Speed</td>
</tr>
<tr>
<td><code>Autopilot.SetSpeed</code></td>
<td>Set autopilot Speed</td>
</tr>
<tr>
<td><code>Autopilot.SetHeadingState</code></td>
<td>Set autopilot Heading On/Off</td>
</tr>
<tr>
<td><code>Autopilot.SetAltitudeState</code></td>
<td>Set autopilot Altitude On/Off</td>
</tr>
<tr>
<td><code>Autopilot.SetVSState</code></td>
<td>Set autopilot Vertical Speed On/Off</td>
</tr>
<tr>
<td><code>Autopilot.SetSpeedState</code></td>
<td>Set autopilot Speed On/Off</td>
</tr>
<tr>
<td><code>Autopilot.SetApproachModeState</code></td>
<td>Set autopilot APPR On/Off</td>
</tr>
<tr>
<td><code>FlightPlan.AddWaypoints</code></td>
<td>Add waypoints to Flight Plan</td>
</tr>
<tr>
<td><code>FlightPlan.Clear</code></td>
<td>Clear Flight Plan</td>
</tr>
<tr>
<td><code>FlightPlan.ActivateLeg</code></td>
<td>Activate a given leg of the Flight Plan</td>
</tr>
</tbody>
</table></div><p><strong>Examples</strong></p>
<p><em>Set HDG to 270</em></p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;Commands.Autopilot.SetHeading&quot;,
  &quot;Parameters&quot;: [{ &quot;Value&quot;: 270 }]
}
</code></pre>
</section>
<section class="reference">
<p><em>Enable HDG</em></p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;Commands.Autopilot.SetHeadingState&quot;,
  &quot;Parameters&quot;: [{ &quot;Value&quot;: true }]
}
</code></pre>
<p><em>Toggle AP</em></p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;Commands.Autopilot.Toggle&quot;,
  &quot;Parameters&quot;: []
}
</code></pre>
</section>
</section>
<section id="simulator-commands">
<h4><a class="header-anchor" href="#simulator-commands"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Simulator Commands</h4>
<section class="sample">
<p>Control on simulator. Example, toggle play/pause.</p>
<pre><code class="language-json">{
  &quot;Command&quot;: &quot;Commands.TogglePause&quot;,
  &quot;Parameters&quot;: []
}
</code></pre>
</section>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>TogglePause</code></td>
<td>Toggle the pause screen</td>
</tr>
<tr>
<td><code>ToggleTime</code></td>
<td>Sets the simulator time</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Connect API v1

Connect API v2

<section id="connect-api-v2-states">
<h1><a class="header-anchor" href="#connect-api-v2-states"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Connect API v2 States</h1>
<section class="reference">
<p>This page contains a reference for all states available in the Connect API v2 and their respective data types. States differ between aircraft but there are many that are common between them all. Select an aircraft to get started, and click on any state to copy it to your clipboard.</p>
<connectStates /></section>
</section>


Connect API v2 States

<section id="connect-api-samples">
<h1><a class="header-anchor" href="#connect-api-samples"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Connect API Samples</h1>
<section class="reference">
<p>Below you can find a range of samples in a variety of languages to help you get started with the Connect API. We welcome contributions, message <a href="https://community.infiniteflight.com/u/cameron" class="documentation-content-link">@Cameron</a> or <a href="https://community.infiniteflight.com/u/kaim/" class="documentation-content-link">@KaiM</a> on the Infinite Flight Community with a link to your project.</p>
<p>These samples are all licensed differently, so check the terms of the license before using them in your own projects.</p>
</section>
<section id="connect-v2">
<h2><a class="header-anchor" href="#connect-v2"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Connect v2</h2>
<section class="reference">
<ul>
<li><a href="https://github.com/carmichaelalonso/infiniteflightapi" class="documentation-content-link">Official v2 Demo</a> - C#</li>
<li><a href="https://community.infiniteflight.com/t/ifc2-new-javascript-client-for-the-connect-v2-api/637176" class="documentation-content-link">ifc2</a> - JavaScript</li>
<li><a href="https://github.com/velocity23/ifconnect-shell" class="documentation-content-link">ifconnect-shell</a> - JavaScript</li>
<li><a href="https://github.com/tomthetank46/SwiftFlight" class="documentation-content-link">SwiftFlight</a> - Swift</li>
<li><a href="https://github.com/sqeezelemon/ConnectKit" class="documentation-content-link">ConnectKit</a> - Swift</li>
</ul>
</section>
</section>
</section>


Samples

<section id="infinite-flight-live-api-overview">
<h1><a class="header-anchor" href="#infinite-flight-live-api-overview"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Infinite Flight Live API Overview</h1>
<section class="reference">
<p>The Live API is our HTTP API used for requesting data from Infinite Flight Servers. Current features include:</p>
<ul>
<li>List available servers for pilots and ATC in-game.</li>
<li>List active flights for each server.</li>
<li>List active ATC for each server.</li>
<li>Retrieve flight plans for each flight.</li>
<li>Retrieve stats for users.</li>
</ul>
</section>
<section id="obtaining-an-api-key">
<h2><a class="header-anchor" href="#obtaining-an-api-key"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Obtaining an API key</h2>
<section class="reference">
<p>An API key is required to use the Live API. Contact <a href="mailto:hello@infiniteflight.com" class="documentation-content-link">hello@infiniteflight.com</a> to let us know what you plan on building and to request a key.</p>
</section>
</section>
<section id="how-to-use-the-api">
<h2><a class="header-anchor" href="#how-to-use-the-api"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> How to use the API</h2>
<section class="reference">
<p>The Live API uses HTTP and the endpoints require you to make a GET or POST request to the endpoint URL. See individual endpoint documentation for specifics</p>
</section>
</section>
<section id="conditions-of-use">
<h2><a class="header-anchor" href="#conditions-of-use"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Conditions of Use</h2>
<section class="reference">
<ul>
<li>
<p>All apps are required to have a timeout feature if the app isn’t being used. We don’t want users to have the app running for hours if no-one is looking. If no action is taken for 15 minutes, have your apps stop downloading new content unless the user presses a button (FlightRadar24 does this on their site).</p>
</li>
<li>
<p>No permanent storing of data retrieved via the API is permitted. (You cannot keep the data in your own database). Caching is permitted.</p>
<p>If you need additional functionality from the API, please contact us.</p>
</li>
</ul>
</section>
</section>
<section id="prerequisites">
<h2><a class="header-anchor" href="#prerequisites"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Prerequisites</h2>
<section class="reference">
<p>This documentation is aimed at someone with knowledge of:</p>
<ul>
<li>HTTP</li>
<li>JSON</li>
<li>Infinite Flight System (Grades, Servers, etc.)</li>
</ul>
<p>If you are not knowledgeable in these areas, you are of course welcome to browse the documentation. You can also check out these resources to help you learn.</p>
<ul>
<li><a href="https://www.w3schools.com/whatis/whatis_http.asp" class="documentation-content-link">W3Schools - What is HTTP?</a></li>
<li><a href="https://www.w3schools.com/js/js_json_intro.asp" class="documentation-content-link">W3Schools - JSON Introduction</a></li>
<li><a href="/guide/getting-started-guide/home-user-interface/user-profile#the-grade-table" class="documentation-content-link">Infinite Flight User Guide</a></li>
</ul>
</section>
</section>
</section>


<section id="get-sessions">
<h1><a class="header-anchor" href="#get-sessions"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Sessions</h1>
<section class="reference">
<p>Retrieve active sessions (servers) in Infinite Flight.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;maxUsers&quot;: 1000,
      &quot;id&quot;: &quot;89573c7f-d398-4281-bcc0-3e9b7f6b8492&quot;,
      &quot;name&quot;: &quot;Sample Server&quot;,
      &quot;userCount&quot;: 187,
      &quot;type&quot;: 0
    }
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[SessionInfo]</td>
<td>Array of SessionInfo objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="sessioninfo">
<h4><a class="header-anchor" href="#sessioninfo"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> SessionInfo</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string</td>
<td>The unique identifier for the server. Use this to request flights and ATC data</td>
</tr>
<tr>
<td><code>name</code></td>
<td>string</td>
<td>Name of the server</td>
</tr>
<tr>
<td><code>maxUsers</code></td>
<td>integer</td>
<td>Maximum number of users the server can accept</td>
</tr>
<tr>
<td><code>userCount</code></td>
<td>integer</td>
<td>Connected users to the server</td>
</tr>
<tr>
<td><code>type</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Unrestricted = 0&quot;</code>, <code>&quot;Restricted = 1&quot;</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Sessions

<section id="get-flights">
<h1><a class="header-anchor" href="#get-flights"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Flights</h1>
<section class="reference">
<p>Retrieve a list of all flights for a session.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions/{sessionId}/flights</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>sessionId</code></td>
<td>path</td>
<td>ID of the session returned from the Sessions endpoint</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;username&quot;: &quot;Cameron&quot;,
      &quot;callsign&quot;: &quot;EC-CAM&quot;,
      &quot;latitude&quot;: 30.123479009207056,
      &quot;longitude&quot;: 31.413340256981044,
      &quot;altitude&quot;: 597.8003749797689,
      &quot;speed&quot;: 185.3844049009562,
      &quot;verticalSpeed&quot;: 2167.31591796875,
      &quot;track&quot;: 162.13836669921875,
      &quot;lastReport&quot;: &quot;2020-10-02 00:46:19Z&quot;,
      &quot;flightId&quot;: &quot;348d1ba8-1e60-48ca-8278-42f019147de8&quot;,
      &quot;userId&quot;: &quot;3f8b28bf-bbb1-4024-80ae-2a0ea9b30685&quot;,
      &quot;aircraftId&quot;: &quot;de510d3d-04f8-46e0-8d65-55b888f33129&quot;,
      &quot;liveryId&quot;: &quot;c875c0e9-19c2-420d-8fb4-32c151bd797c&quot;,
      &quot;heading&quot;: 159.33542,
      &quot;virtualOrganization&quot;: &quot;IFATC [IFATC]&quot;
    }
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[FlightEntry]</td>
<td>Array of FlightEntry objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="flightentry">
<h4><a class="header-anchor" href="#flightentry"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> FlightEntry</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>flightId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the flight</td>
</tr>
<tr>
<td><code>userId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the user</td>
</tr>
<tr>
<td><code>aircraftId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the aircraft type</td>
</tr>
<tr>
<td><code>liveryId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the livery and aircraft combination.</td>
</tr>
<tr>
<td><code>username</code></td>
<td>string</td>
<td>The user's forum username if the account is linked. If the account isn't linked, this will be null</td>
</tr>
<tr>
<td><code>virtualOrganization</code></td>
<td>string</td>
<td>The virtual organization of the user's forum account if linked. Can be null if not set</td>
</tr>
<tr>
<td><code>callsign</code></td>
<td>string</td>
<td>Callsign for the flight</td>
</tr>
<tr>
<td><code>latitude</code></td>
<td>double</td>
<td>Current decimal latitude of the aircraft</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>double</td>
<td>Current decimal longitude of the aircraft</td>
</tr>
<tr>
<td><code>altitude</code></td>
<td>double</td>
<td>Current altitude of the aircraft in feet</td>
</tr>
<tr>
<td><code>speed</code></td>
<td>double</td>
<td>Current groundspeed of the aircraft in knots</td>
</tr>
<tr>
<td><code>verticalSpeed</code></td>
<td>double</td>
<td>Current vertical speed of the aircraft in ft/min</td>
</tr>
<tr>
<td><code>track</code></td>
<td>double</td>
<td>Track of the aircraft in degrees</td>
</tr>
<tr>
<td><code>heading</code></td>
<td>float</td>
<td>Heading of the aircraft in degrees</td>
</tr>
<tr>
<td><code>lastReport</code></td>
<td>string</td>
<td>Last position report time of the flight in the following format: <code>YYYY-MM-DD HH:mm:ssZ</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Flights

<section id="get-flight-route">
<h1><a class="header-anchor" href="#get-flight-route"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Flight Route</h1>
<section class="reference">
<p>Retrieve the flown route of a specific flight with position, altitude, speed and track information at different points in time.</p>
<p>Please note, this is currently only supported on the Expert Server and Training Server.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions/{sessionId}/flights/{flightId}/route</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>flightId</code></td>
<td>path</td>
<td>ID of the flight. The flight must be in an active session.</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;latitude&quot;: 25.52992361245416,
      &quot;longitude&quot;: -80.33701239710909,
      &quot;altitude&quot;: 18429.91132829714,
      &quot;track&quot;: 75.00002,
      &quot;groundSpeed&quot;: 194.6716372048416,
      &quot;date&quot;: &quot;2021-01-06T16:20:27.3275657Z&quot;
    },
    {
      &quot;latitude&quot;: 25.59595843191219,
      &quot;longitude&quot;: -79.96882929194611,
      &quot;altitude&quot;: 27448.993829140254,
      &quot;track&quot;: 77.0936,
      &quot;groundSpeed&quot;: 229.58654094765924,
      &quot;date&quot;: &quot;2021-01-06T16:23:27.4572883Z&quot;
    },
    {
      &quot;latitude&quot;: 25.621774462118506,
      &quot;longitude&quot;: -79.56246802075516,
      &quot;altitude&quot;: 30999.01751208178,
      &quot;track&quot;: 110.30767,
      &quot;groundSpeed&quot;: 235.4484678810845,
      &quot;date&quot;: &quot;2021-01-06T16:26:27.5268907Z&quot;
    }
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[PositionReport]</td>
<td>Array of PositionReport objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="positionreport">
<h4><a class="header-anchor" href="#positionreport"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> PositionReport</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>latitude</code></td>
<td>double</td>
<td>Decimal latitude of the aircraft at this position.</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>double</td>
<td>Decimal longitude of the aircraft at this position.</td>
</tr>
<tr>
<td><code>altitude</code></td>
<td>double</td>
<td>Altitude of the aircraft in feet.</td>
</tr>
<tr>
<td><code>track</code></td>
<td>double</td>
<td>Track / Course of aircraft in degrees</td>
</tr>
<tr>
<td><code>groundSpeed</code></td>
<td>double</td>
<td>Ground speed of the aircraft in knots</td>
</tr>
<tr>
<td><code>date</code></td>
<td>string</td>
<td>Position report time of the flight in the following format: <code>YYYY-MM-DD HH:mm:ssZ</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Flight Route

<section id="get-detailed-flight-plan">
<h1><a class="header-anchor" href="#get-detailed-flight-plan"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Detailed Flight Plan</h1>
<section class="reference">
<p>Retrieve the flight plan for a specific active flight.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions/{sessionId}/flights/{flightId}/flightplan</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>flightId</code></td>
<td>path</td>
<td>ID of the flight. The flight must be in an active session and have a filed flight plan.</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: {
      &quot;flightPlanId&quot;: &quot;4a57de08-a3b1-48ba-a081-adeff0a5b503&quot;,
      &quot;flightId&quot;: &quot;0b8cc273-d97d-4223-afac-907d09d8ca8b&quot;,
      &quot;waypoints&quot;: [
        &quot;AMAHE&quot;,
        &quot;L12R&quot;
      ],
      &quot;lastUpdate&quot;: &quot;2021-01-06 15:35:04Z&quot;,
      &quot;flightPlanItems&quot;: [
        {
          &quot;name&quot;: &quot;AMAHE&quot;,
          &quot;type&quot;: 0,
          &quot;children&quot;: null,
          &quot;identifier&quot;: null,
          &quot;altitude&quot;: -1,
          &quot;location&quot;: {
            &quot;latitude&quot;: 26.92723722,
            &quot;longitude&quot;: -77.47139889,
            &quot;altitude&quot;: 0
          }
        },
        {
          &quot;name&quot;: &quot;L12R&quot;,
          &quot;type&quot;: 2,
          &quot;children&quot;: [
            {
              &quot;name&quot;: &quot;ZESTY&quot;,
              &quot;type&quot;: 0,
              &quot;children&quot;: null,
              &quot;identifier&quot;: &quot;ZESTY&quot;,
              &quot;altitude&quot;: 4000,
              &quot;location&quot;: {
                &quot;latitude&quot;: 44.97196917,
                &quot;longitude&quot;: -93.429735,
                &quot;altitude&quot;: 0
              }
            },
            {
              &quot;name&quot;: &quot;RW12R&quot;,
              &quot;type&quot;: 0,
              &quot;children&quot;: null,
              &quot;identifier&quot;: &quot;RW12R&quot;,
              &quot;altitude&quot;: -1,
              &quot;location&quot;: {
                &quot;latitude&quot;: 44.887794494628906,
                &quot;longitude&quot;: -93.23413848876953,
                &quot;altitude&quot;: 0
              }
            }
          ],
          &quot;identifier&quot;: &quot;L12R&quot;,
          &quot;altitude&quot;: 0,
          &quot;location&quot;: {
            &quot;latitude&quot;: 0,
            &quot;longitude&quot;: 0,
            &quot;altitude&quot;: 0
          }
        }
      ]
    }
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[FlightPlanInfo]</td>
<td>Array of FlightPlanInfo objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="flightplaninfo">
<h4><a class="header-anchor" href="#flightplaninfo"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> FlightPlanInfo</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>flightPlanId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the flight plan</td>
</tr>
<tr>
<td><code>flightId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the flight. Associate with the response from the Get Flights endpoint</td>
</tr>
<tr>
<td><code>waypoints</code></td>
<td>[string]</td>
<td><strong>Deprecated</strong>. An array of waypoint names. You can correlate these with data from the <a href="https://github.com/infiniteflightairportediting/" class="documentation-content-link">Airport Editing Project</a></td>
</tr>
<tr>
<td><code>lastUpdate</code></td>
<td>string</td>
<td>Last report time of the flight plan in the following format: <code>YYYY-MM-DD HH:mm:ssZ</code></td>
</tr>
<tr>
<td><code>flightPlanItems</code></td>
<td>[FlightPlanItem]</td>
<td>An array of FlightPlanItems which contain waypoint and procedure data for points in a flight plan.</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="flightplanitem">
<h4><a class="header-anchor" href="#flightplanitem"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> FlightPlanItem</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>name</code></td>
<td>string</td>
<td>Name of the waypoint or the procedure. In the <code>children</code> array, this is the name of a waypoint inside a procedure.</td>
</tr>
<tr>
<td><code>type</code></td>
<td>integer</td>
<td>Type of procedure for this item. Only use this if the FlightPlanItem's <code>children</code> field is populated and not null. <em>Enum:</em> <code>&quot;Sid = 0&quot;</code>, <code>&quot;STAR = 1&quot;</code>,  <code>&quot;Approach = 2&quot;</code>, <code>&quot;Track = 3&quot;</code>, <code>&quot;Unknown = 5&quot;</code></td>
</tr>
<tr>
<td><code>children</code></td>
<td>[FlightPlanItem]</td>
<td>An array of FlightPlanItems containing waypoint information about a procedure. Only present if this item defines a procedure (SID/STAR/Approach/Track). If not, assume this is a Fix/VOR/Custom User Waypoint.</td>
</tr>
<tr>
<td><code>identifier</code></td>
<td>string</td>
<td>Identifier for the waypoint or the procedure. This is not unique.</td>
</tr>
<tr>
<td><code>altitude</code></td>
<td>integer</td>
<td>The altitude in feet for this waypoint. This is optionally defined by the user and defaults to <code>-1</code> if not set.</td>
</tr>
<tr>
<td><code>location</code></td>
<td>Coordinate</td>
<td>A Coordinate object defining the position of this waypoint.</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="coordinate">
<h4><a class="header-anchor" href="#coordinate"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Coordinate</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>latitude</code></td>
<td>double</td>
<td>Current decimal latitude of the aircraft</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>double</td>
<td>Current decimal longitude of the aircraft</td>
</tr>
<tr>
<td><code>altitude</code></td>
<td>double</td>
<td>Current decimal altitude of the aircraft</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Flight Plan

<section id="get-active-atc-frequencies">
<h1><a class="header-anchor" href="#get-active-atc-frequencies"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Active ATC Frequencies</h1>
<section class="reference">
<p>Retrieve active Air Traffic Control frequencies for a session</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions/{sessionId}/atc</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>sessionId</code></td>
<td>path</td>
<td>ID of the session returned from the Sessions endpoint</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
    &quot;errorCode&quot;: 0,
    &quot;result&quot;: [
        {
            &quot;frequencyId&quot;: &quot;c2d7decc-2803-c905-5d88-81bc07626b1f&quot;,
            &quot;userId&quot;: &quot;3f8b28bf-bbb1-4024-80ae-2a0ea9b30685&quot;,
            &quot;username&quot;: &quot;Cameron&quot;,
            &quot;virtualOrganization&quot;: null,
            &quot;airportName&quot;: &quot;LEPA&quot;,
            &quot;type&quot;: 1,
            &quot;latitude&quot;: 39.551575,
            &quot;longitude&quot;: 2.736811,
            &quot;startTime&quot;: &quot;2020-10-02 15:47:25Z&quot;
        }
    ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[ActiveATCFacility]</td>
<td>Array of ActiveATCFacility objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="activeatcfacility">
<h4><a class="header-anchor" href="#activeatcfacility"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> ActiveATCFacility</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>frequencyId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the open frequency</td>
</tr>
<tr>
<td><code>userId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the user controlling the frequency</td>
</tr>
<tr>
<td><code>username</code></td>
<td>string</td>
<td>The user's forum username if the account is linked. If the account isn't linked, this will be null</td>
</tr>
<tr>
<td><code>virtualOrganization</code></td>
<td>string</td>
<td><em>(not currently in use)</em></td>
</tr>
<tr>
<td><code>airportName</code></td>
<td>string</td>
<td>The 4-character ICAO identifier for the airport. <code>null</code> for center</td>
</tr>
<tr>
<td><code>type</code></td>
<td>integer</td>
<td>The type of frequency opened - not all of these are in use. <em>Enum:</em> <code>&quot;Ground = 0&quot;</code>, <code>&quot;Tower = 1&quot;</code>, <code>&quot;Unicom = 2&quot;</code>, <code>&quot;Clearance = 3&quot;</code>, <code>&quot;Approach = 4&quot;</code>, <code>&quot;Departure = 5&quot;</code>, <code>&quot;Center = 6&quot;</code>, <code>&quot;ATIS = 7&quot;</code>, <code>&quot;Aircraft = 8&quot;</code>, <code>&quot;Recorded = 9&quot;</code>, <code>&quot;Unknown = 10&quot;</code>, <code>&quot;Unused = 11&quot;</code></td>
</tr>
<tr>
<td><code>latitude</code></td>
<td>float</td>
<td>Decimal latitude of the airport</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>float</td>
<td>Decimal longitude of the airport</td>
</tr>
<tr>
<td><code>startTime </code></td>
<td>string</td>
<td>Time at which the frequency was opened, in the following format: <code>YYYY-MM-DD HH:mm:ssZ</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Active ATC Frequencies

<section id="get-user-stats">
<h1><a class="header-anchor" href="#get-user-stats"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get User Stats</h1>
<section class="reference">
<p>Retrieve user statistics for up to 25 users at once, including their grade, flight time and username.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>POST</strong> <code>https://api.infiniteflight.com/public/v2/users</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<p><em>Request Content-Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>userIds</code></td>
<td>POST request body</td>
<td>An array of user ID strings retrieved from another endpoint</td>
<td>No*</td>
<td>[string (uuid)]</td>
</tr>
<tr>
<td><code>discourseNames</code></td>
<td>POST request body</td>
<td>An array of IFC Usernames. Not case sensitive.</td>
<td>No*</td>
<td>[string]</td>
</tr>
<tr>
<td><code>userHashes</code></td>
<td>POST request body</td>
<td>An array of user hashes retrieved in-app or from another endpoint. All letters must be upper case.</td>
<td>No*</td>
<td>[string]</td>
</tr>
</tbody>
</table></div><p><em>*At least one search parameter is required</em></p>
</section>
<section id="sample-body">
<h4><a class="header-anchor" href="#sample-body"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Body</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;userIds&quot;: [
    &quot;2a11e620-1cc1-4ac6-90d1-18c4ed9cb913&quot;,
    &quot;5917d076-88a5-40e7-95e0-8818748f8e99&quot;
  ],
  &quot;discourseNames&quot;: [
      &quot;KaiM&quot;,
      &quot;Laura&quot;
  ],
  &quot;userHashes&quot;: [
      &quot;F0081CAA&quot;,
      &quot;E2087C9F&quot;
  ],
}
</code></pre>
</section>
<section class="reference"></section>
</section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;onlineFlights&quot;: 2449,
      &quot;violations&quot;: 102,
      &quot;xp&quot;: 572128,
      &quot;landingCount&quot;: 898,
      &quot;flightTime&quot;: 45983,
      &quot;atcOperations&quot;: 548,
      &quot;atcRank&quot;: 7,
      &quot;grade&quot;: 5,
      &quot;hash&quot;: &quot;5F0973A9&quot;,
      &quot;violationCountByLevel&quot;: {
        &quot;level1&quot;: 102,
        &quot;level2&quot;: 0,
        &quot;level3&quot;: 0
      },
      &quot;roles&quot;: [
        1,
        2,
        64
      ],
      &quot;userId&quot;: &quot;2a11e620-1cc1-4ac6-90d1-18c4ed9cb913&quot;,
      &quot;virtualOrganization&quot;: null,
      &quot;discourseUsername&quot;: &quot;Cameron&quot;,
      &quot;groups&quot;: [
        &quot;8c93a113-0c6c-491f-926d-1361e43a5833&quot;,
        &quot;d07afad8-79df-4363-b1c7-a5a1dde6e3c8&quot;,
        &quot;df0f6341-5f6a-40ef-8b73-087a0ec255b5&quot;
      ],
      &quot;errorCode&quot;: 0
    },
    {
      &quot;onlineFlights&quot;: 21,
      &quot;violations&quot;: 0,
      &quot;xp&quot;: 29984,
      &quot;landingCount&quot;: 24,
      &quot;flightTime&quot;: 2717,
      &quot;atcOperations&quot;: 0,
      &quot;atcRank&quot;: null,
      &quot;grade&quot;: 1,
      &quot;hash&quot;: &quot;56099EA4&quot;,
      &quot;userId&quot;: &quot;66e362c0-894b-495b-93a6-75f9befa502d&quot;,
      &quot;virtualOrganization&quot;: null,
      &quot;discourseUsername&quot;: null,
       &quot;violationCountByLevel&quot;: {
        &quot;level1&quot;: 22,
        &quot;level2&quot;: 0,
        &quot;level3&quot;: 0
      },
      &quot;roles&quot;: [
        64
      ],
      &quot;groups&quot;: [],
      &quot;errorCode&quot;: 0
    }
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[UserStats]</td>
<td>Array of UserStats objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="userstats">
<h4><a class="header-anchor" href="#userstats"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> UserStats</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>userId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the user</td>
</tr>
<tr>
<td><code>virtualOrganization</code></td>
<td>string</td>
<td>The virtual organization of the user's forum account if linked. Can be null if not set</td>
</tr>
<tr>
<td><code>discourseUsername</code></td>
<td>string</td>
<td>The user's forum username if the account is linked. If the account isn't linked, this will be null</td>
</tr>
<tr>
<td><code>groups</code></td>
<td>[string (uuid)]</td>
<td><strong>Deprecated - will be removed in a future update</strong> A list of groups the user can be a part of.</td>
</tr>
<tr>
<td><code>roles</code></td>
<td>[integer]</td>
<td>A list of roles a user has been assigned. See below for a list of main roles.</td>
</tr>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td>Status code of user query. Not in use for this endpoint</td>
</tr>
<tr>
<td><code>onlineFlights</code></td>
<td>integer</td>
<td>Number of flights carried out in multiplayer</td>
</tr>
<tr>
<td><code>violations</code></td>
<td>integer</td>
<td>Number of Level 1, 2 and 3 violations the user received in multiplayer</td>
</tr>
<tr>
<td><code>violationCountByLevel</code></td>
<td>dict</td>
<td>A dictionary with a count of violations issued to the user, split up by levels (Level 1/2/3).</td>
</tr>
<tr>
<td><code>xp</code></td>
<td>double</td>
<td>Total XP obtained in multiplayer</td>
</tr>
<tr>
<td><code>landingCount</code></td>
<td>integer</td>
<td>Total landings carried out in multiplayer</td>
</tr>
<tr>
<td><code>flightTime</code></td>
<td>double</td>
<td>Total flight time in minutes in multiplayer</td>
</tr>
<tr>
<td><code>atcOperations</code></td>
<td>integer</td>
<td>Total number of ATC Operations.</td>
</tr>
<tr>
<td><code>atcRank</code></td>
<td>integer</td>
<td>ATC Rank on the Expert Server. See below for the ranks. Can be null if user isn't an IFATC controller.</td>
</tr>
<tr>
<td><code>grade</code></td>
<td>integer</td>
<td>The grade of the user, from 1 to 5.</td>
</tr>
<tr>
<td><code>hash</code></td>
<td>string</td>
<td>A short-form user identifier, shown in the app to identify anonymous users.</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="roles">
<h4><a class="header-anchor" href="#roles"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Roles</h4>
<section class="reference">
<p>The main roles are as follows.</p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>ID</th>
<th>Name</th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>Infinite Flight Staff</td>
</tr>
<tr>
<td>2</td>
<td>Moderators</td>
</tr>
<tr>
<td>64</td>
<td>IFATC Members</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="atc-ranks">
<h4><a class="header-anchor" href="#atc-ranks"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> ATC Ranks</h4>
<section class="reference">
<p>The ATC Ranks are as follows.</p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>ID</th>
<th>Name</th>
</tr>
</thead>
<tbody>
<tr>
<td>0</td>
<td>Observer</td>
</tr>
<tr>
<td>1</td>
<td>ATC Trainee</td>
</tr>
<tr>
<td>2</td>
<td>ATC Apprentice</td>
</tr>
<tr>
<td>3</td>
<td>ATC Specialist</td>
</tr>
<tr>
<td>4</td>
<td>ATC Officer</td>
</tr>
<tr>
<td>5</td>
<td>ATC Supervisor</td>
</tr>
<tr>
<td>6</td>
<td>ATC Recruiter</td>
</tr>
<tr>
<td>7</td>
<td>ATC Manager</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get User Stats

Get User Grade

<section id="get-airport-atis">
<h1><a class="header-anchor" href="#get-airport-atis"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Airport ATIS</h1>
<section class="reference">
<p>Retrieve the ATIS for an airport on a specific server if it is active.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions/{sessionId}/airport/{airportIcao}/atis</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>airportIcao</code></td>
<td>query</td>
<td>ICAO of the airport to get the ATIS for</td>
<td>Yes</td>
<td>string</td>
</tr>
<tr>
<td><code>sessionId</code></td>
<td>query</td>
<td>Session (Server) ID of the Live Server</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
    &quot;errorCode&quot;:0,
    &quot;result&quot;:&quot;Manchester Airport, ATIS information DELTA, time 2355 ZULU, Wind 350 at 6 Visibility 21, Temperature 2, Dew Point 0, QNH 1024. Remarks, no pattern work allowed, no light aircraft accepted at this time. Landing Runways 05L and 05R, Departing Runways 05L and 05R. Advise on initial contact, you have information DELTA.&quot;
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>string</td>
<td>The ATIS, or <code>null</code> if it is not available</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Airport ATIS

<section id="get-airport-status">
<h1><a class="header-anchor" href="#get-airport-status"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Airport Status</h1>
<section class="reference">
<p>Retrieve active ATC status information for an airport, and the number of inbound and outbound aircraft.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions/{sessionId}/airport/{airportIcao}/status</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>airportIcao</code></td>
<td>query</td>
<td>ICAO of the airport to get the status for</td>
<td>Yes</td>
<td>string</td>
</tr>
<tr>
<td><code>sessionId</code></td>
<td>query</td>
<td>Session (Server) ID of the Live Server</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: {
    &quot;airportIcao&quot;: &quot;VTBS&quot;,
    &quot;inboundFlightsCount&quot;: 40,
    &quot;inboundFlights&quot;: [
      &quot;4f559855-fecc-4a8a-a95e-1d097eed9b72&quot;,
	  ...
    ],
    &quot;outboundFlightsCount&quot;: 19,
    &quot;outboundFlights&quot;: [
      &quot;59e9509b-214a-4f8c-9d45-29c4f7ea01d7&quot;,
	  ...
    ],
    &quot;atcFacilities&quot;: [
      {
        &quot;frequencyId&quot;: &quot;23bea566-20a0-2858-a40e-179d0699afc1&quot;,
        &quot;userId&quot;: &quot;05328fc4-b651-45e9-8e1f-328095329484&quot;,
        &quot;username&quot;: &quot;Rhys_V&quot;,
        &quot;virtualOrganization&quot;: null,
        &quot;airportName&quot;: &quot;VTBS&quot;,
        &quot;type&quot;: 4,
        &quot;latitude&quot;: 13.680815,
        &quot;longitude&quot;: 100.74768,
        &quot;startTime&quot;: &quot;2021-02-08 09:59:58Z&quot;
      }
    ]
  }
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>string</td>
<td>An <code>AirportStatus</code> object</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="airport-status">
<h4><a class="header-anchor" href="#airport-status"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Airport Status</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>airportIcao</code></td>
<td>string</td>
<td>ICAO of the airport</td>
</tr>
<tr>
<td><code>inboundFlightsCount</code></td>
<td>integer</td>
<td>Number of aircraft inbound to this airport (must have final waypoint in flight plan set as the airport ICAO)</td>
</tr>
<tr>
<td><code>inboundFlights</code></td>
<td>[string (uuid)]</td>
<td>A list of flight identifiers inbound to this airport. Use this to get flight plans or flight route information</td>
</tr>
<tr>
<td><code>outboundFlightsCount</code></td>
<td>integer</td>
<td>Number of aircraft departing this airport (must have first waypoint in flight plan set as the airport ICAO)</td>
</tr>
<tr>
<td><code>outboundFlights</code></td>
<td>[string (uuid)]</td>
<td>A list of flight identifiers outbound from this airport. Use this to get flight plans or flight route information</td>
</tr>
<tr>
<td><code>atcFacilities</code></td>
<td>[ActiveATCFacility]</td>
<td>Array of ActiveATCFacility objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="activeatcfacility">
<h4><a class="header-anchor" href="#activeatcfacility"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> ActiveATCFacility</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>frequencyId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the open frequency</td>
</tr>
<tr>
<td><code>userId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the user controlling the frequency</td>
</tr>
<tr>
<td><code>username</code></td>
<td>string</td>
<td>The user's forum username if the account is linked. If the account isn't linked, this will be null</td>
</tr>
<tr>
<td><code>virtualOrganization</code></td>
<td>string</td>
<td><em>(not currently in use)</em></td>
</tr>
<tr>
<td><code>airportName</code></td>
<td>string</td>
<td>The 4-character ICAO identifier for the airport. <code>null</code> for center</td>
</tr>
<tr>
<td><code>type</code></td>
<td>integer</td>
<td>The type of frequency opened - not all of these are in use. <em>Enum:</em> <code>&quot;Ground = 0&quot;</code>, <code>&quot;Tower = 1&quot;</code>, <code>&quot;Unicom = 2&quot;</code>, <code>&quot;Clearance = 3&quot;</code>, <code>&quot;Approach = 4&quot;</code>, <code>&quot;Departure = 5&quot;</code>, <code>&quot;Center = 6&quot;</code>, <code>&quot;ATIS = 7&quot;</code>, <code>&quot;Aircraft = 8&quot;</code>, <code>&quot;Recorded = 9&quot;</code>, <code>&quot;Unknown = 10&quot;</code>, <code>&quot;Unused = 11&quot;</code></td>
</tr>
<tr>
<td><code>latitude</code></td>
<td>float</td>
<td>Decimal latitude of the airport</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>float</td>
<td>Decimal longitude of the airport</td>
</tr>
<tr>
<td><code>startTime </code></td>
<td>string</td>
<td>Time at which the frequency was opened, in the following format: <code>YYYY-MM-DD HH:mm:ssZ</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Airport Status

<section id="get-world-status">
<h1><a class="header-anchor" href="#get-world-status"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get World Status</h1>
<section class="reference">
<p>Retrieve active ATC status information and inbound/outbound aircraft information for all airports with activity on a specific server.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions/{sessionId}/world</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>sessionId</code></td>
<td>query</td>
<td>Session (Server) ID of the Live Server</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;airportIcao&quot;: &quot;KLAX&quot;,
      &quot;inboundFlightsCount&quot;: 103,
      &quot;inboundFlights&quot;: [
        &quot;e1cf6c27-6f18-43a0-8bf8-cec5406e93a0&quot;,
        ...
      ],
      &quot;outboundFlightsCount&quot;: 39,
      &quot;outboundFlights&quot;: [
        &quot;e2ded8f8-ff70-454a-911b-f193eb47636f&quot;,
        ...
      ],
      &quot;atcFacilities&quot;: [
        {
          &quot;frequencyId&quot;: &quot;ee835f12-6cf5-eaa1-04bf-2018c7c01ae0&quot;,
          &quot;userId&quot;: &quot;51f94d83-54e8-4674-ae2d-046a42c04f7a&quot;,
          &quot;username&quot;: &quot;Manav_Suri&quot;,
          &quot;virtualOrganization&quot;: null,
          &quot;airportName&quot;: &quot;KLAX&quot;,
          &quot;type&quot;: 0,
          &quot;latitude&quot;: 33.943123,
          &quot;longitude&quot;: -118.40881,
          &quot;startTime&quot;: &quot;2021-02-09 09:53:02Z&quot;
        },
        ...
      ]
    },
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[AirportStatus]</td>
<td>An array of <code>AirportStatus</code> objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="airportstatus">
<h4><a class="header-anchor" href="#airportstatus"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> AirportStatus</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>airportIcao</code></td>
<td>string</td>
<td>ICAO of the airport</td>
</tr>
<tr>
<td><code>inboundFlightsCount</code></td>
<td>integer</td>
<td>Number of aircraft inbound to this airport (must have final waypoint in flight plan set as the airport ICAO)</td>
</tr>
<tr>
<td><code>inboundFlights</code></td>
<td>[string (uuid)]</td>
<td>A list of flight identifiers inbound to this airport. Use this to get flight plans or flight route information</td>
</tr>
<tr>
<td><code>outboundFlightsCount</code></td>
<td>integer</td>
<td>Number of aircraft departing this airport (must have first waypoint in flight plan set as the airport ICAO)</td>
</tr>
<tr>
<td><code>outboundFlights</code></td>
<td>[string (uuid)]</td>
<td>A list of flight identifiers outbound from this airport. Use this to get flight plans or flight route information</td>
</tr>
<tr>
<td><code>atcFacilities</code></td>
<td>[ActiveATCFacility]</td>
<td>Array of ActiveATCFacility objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="activeatcfacility">
<h4><a class="header-anchor" href="#activeatcfacility"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> ActiveATCFacility</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>frequencyId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the open frequency</td>
</tr>
<tr>
<td><code>userId</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the user controlling the frequency</td>
</tr>
<tr>
<td><code>username</code></td>
<td>string</td>
<td>The user's forum username if the account is linked. If the account isn't linked, this will be null</td>
</tr>
<tr>
<td><code>virtualOrganization</code></td>
<td>string</td>
<td><em>(not currently in use)</em></td>
</tr>
<tr>
<td><code>airportName</code></td>
<td>string</td>
<td>The 4-character ICAO identifier for the airport. <code>null</code> for center</td>
</tr>
<tr>
<td><code>type</code></td>
<td>integer</td>
<td>The type of frequency opened - not all of these are in use. <em>Enum:</em> <code>&quot;Ground = 0&quot;</code>, <code>&quot;Tower = 1&quot;</code>, <code>&quot;Unicom = 2&quot;</code>, <code>&quot;Clearance = 3&quot;</code>, <code>&quot;Approach = 4&quot;</code>, <code>&quot;Departure = 5&quot;</code>, <code>&quot;Center = 6&quot;</code>, <code>&quot;ATIS = 7&quot;</code>, <code>&quot;Aircraft = 8&quot;</code>, <code>&quot;Recorded = 9&quot;</code>, <code>&quot;Unknown = 10&quot;</code>, <code>&quot;Unused = 11&quot;</code></td>
</tr>
<tr>
<td><code>latitude</code></td>
<td>float</td>
<td>Decimal latitude of the airport</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>float</td>
<td>Decimal longitude of the airport</td>
</tr>
<tr>
<td><code>startTime </code></td>
<td>string</td>
<td>Time at which the frequency was opened, in the following format: <code>YYYY-MM-DD HH:mm:ssZ</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get World Status

<section id="get-oceanic-tracks">
<h1><a class="header-anchor" href="#get-oceanic-tracks"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Oceanic Tracks</h1>
<section class="reference">
<p>Retrieves a list of Oceanic Tracks active in Infinite Flight multiplayer sessions.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/tracks</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<p><em>No parameters required.</em></p>
</section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;name&quot;: &quot;A&quot;,
      &quot;path&quot;: [
        &quot;DINIM&quot;,
        &quot;51/20&quot;,
        &quot;51/30&quot;,
        &quot;50/40&quot;,
        &quot;49/50&quot;,
        &quot;JOOPY&quot;
      ],
      &quot;eastLevels&quot;: null,
      &quot;westLevels&quot;: [
        350,
        370,
        390
      ],
      &quot;type&quot;: &quot;North Atlantic Tracks&quot;,
      &quot;lastSeen&quot;: &quot;2021-01-06T18:49:33.6300772Z&quot;
    }
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[OceanicTrack]</td>
<td>An array of tracks that are active in Infinite Flight.</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="oceanictrack">
<h4><a class="header-anchor" href="#oceanictrack"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> OceanicTrack</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>name</code></td>
<td>string</td>
<td>Name of the track. This is normally represented by letters.</td>
</tr>
<tr>
<td><code>path</code></td>
<td>[string]</td>
<td>You can correlate these with data from the <a href="https://github.com/infiniteflightairportediting/" class="documentation-content-link">Airport Editing Project</a></td>
</tr>
<tr>
<td><code>eastLevels</code></td>
<td>[integer]</td>
<td>An array of Flight Level altitudes that aircraft can fly eastbound on using this track.</td>
</tr>
<tr>
<td><code>westLevels</code></td>
<td>[integer]</td>
<td>An array of Flight Level altitudes that aircraft can fly westbound on using this track.</td>
</tr>
<tr>
<td><code>type</code></td>
<td>string</td>
<td>Type of Oceanic Track. Infinite Flight supports <code>North Atlantic Tracks</code> in addition to custom tracks defined for events.</td>
</tr>
<tr>
<td><code>lastSeen</code></td>
<td>string</td>
<td>Last date and time at which the Oceanic Tracks were updated, in the following format: <code>YYYY-MM-DDTHH:mm:ssZ</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Oceanic Tracks

<section id="get-user-flights">
<h1><a class="header-anchor" href="#get-user-flights"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get User Flights</h1>
<section class="reference">
<p>Retrieves the online flight logbook for a given user.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/users/{userId}/flights</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>userId</code></td>
<td>path</td>
<td>ID of the User</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
<tr>
<td><code>page</code></td>
<td>query</td>
<td>Index of the page to retrieve</td>
<td>No, default <code>1</code></td>
<td>integer</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: {
    &quot;pageIndex&quot;: 1,
    &quot;totalPages&quot;: 80,
    &quot;totalCount&quot;: 799,
    &quot;hasPreviousPage&quot;: false,
    &quot;hasNextPage&quot;: true,
    &quot;data&quot;: [
      {
        &quot;id&quot;: &quot;9aeb16a3-ac69-41d3-9dd4-d62be72b1525&quot;,
        &quot;created&quot;: &quot;2022-01-10T10:37:41.965626&quot;,
        &quot;userId&quot;: &quot;b0018209-e010-40a0-afe1-00ecd5856c5e&quot;,
        &quot;aircraftId&quot;: &quot;849366e1-cb11-4d72-9034-78b11cd026b0&quot;,
        &quot;liveryId&quot;: &quot;a071518d-995a-4b3c-b65b-656da0d6ed86&quot;,
        &quot;callsign&quot;: &quot;VH-KAI&quot;,
        &quot;server&quot;: &quot;Casual Server&quot;,
        &quot;dayTime&quot;: 2.5355167,
        &quot;nightTime&quot;: 0,
        &quot;totalTime&quot;: 2.5355167,
        &quot;landingCount&quot;: 0,
        &quot;originAirport&quot;: &quot;YTYA&quot;,
        &quot;destinationAirport&quot;: &quot;YTYA&quot;,
        &quot;xp&quot;: 25
      },
      ...
    ]
  }
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>PaginatedList</td>
<td>A page from the logbook.</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="paginated-list">
<h4><a class="header-anchor" href="#paginated-list"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Paginated List</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>pageIndex</code></td>
<td>integer</td>
<td>The index of the current page</td>
</tr>
<tr>
<td><code>totalPages</code></td>
<td>integer</td>
<td>The total number of pages available</td>
</tr>
<tr>
<td><code>totalCount</code></td>
<td>integer</td>
<td>The total amount of entries for this dataset</td>
</tr>
<tr>
<td><code>hasPreviousPage</code></td>
<td>boolean</td>
<td>Whether there is a page before this one</td>
</tr>
<tr>
<td><code>hasNextPage</code></td>
<td>boolean</td>
<td>Whether there is a page after this one</td>
</tr>
<tr>
<td><code>data</code></td>
<td>[UserFlight]</td>
<td>The entries in the current page</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="userflight">
<h4><a class="header-anchor" href="#userflight"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> UserFlight</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>The ID of the flight</td>
</tr>
<tr>
<td><code>created</code></td>
<td>string (datetime)</td>
<td>The time the flight was created</td>
</tr>
<tr>
<td><code>userId</code></td>
<td>string (uuid)</td>
<td>The ID of the user who flew the flight</td>
</tr>
<tr>
<td><code>aircraftId</code></td>
<td>string (uuid)</td>
<td>The ID of the aircraft flown</td>
</tr>
<tr>
<td><code>liveryId</code></td>
<td>string (uuid)</td>
<td>The ID of the livery flown. <strong>This is currently only supported on the Casual server</strong></td>
</tr>
<tr>
<td><code>callsign</code></td>
<td>string</td>
<td>The callsign of the user during this flight</td>
</tr>
<tr>
<td><code>server</code></td>
<td>string</td>
<td>The name of the server the flight was flown on</td>
</tr>
<tr>
<td><code>dayTime</code></td>
<td>float</td>
<td>The flight time during the day, in minutes</td>
</tr>
<tr>
<td><code>nightTime</code></td>
<td>float</td>
<td>The flight time during the night, in minutes</td>
</tr>
<tr>
<td><code>totalTime</code></td>
<td>float</td>
<td>The total flight time of the flight, in minutes</td>
</tr>
<tr>
<td><code>landingCount</code></td>
<td>integer</td>
<td>The number of landings conducted during the flight</td>
</tr>
<tr>
<td><code>originAirport</code></td>
<td>string</td>
<td>The ICAO code of the departure airport. Can be null</td>
</tr>
<tr>
<td><code>destinationAirport</code></td>
<td>string</td>
<td>The ICAO code of the arrival airport. Can be null</td>
</tr>
<tr>
<td><code>xp</code></td>
<td>integer</td>
<td>The number of XP earned during the flight</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get User Flights

<section id="get-user-flights">
<h1><a class="header-anchor" href="#get-user-flights"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get User Flights</h1>
<section class="reference">
<p>Retrieves a flight from the logbook of a given user.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/users/{userId}/flights/{flightId}</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>userId</code></td>
<td>path</td>
<td>ID of the User</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
<tr>
<td><code>flightId</code></td>
<td>path</td>
<td>ID of the Flight</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: {
    &quot;id&quot;: &quot;9aeb16a3-ac69-41d3-9dd4-d62be72b1525&quot;,
    &quot;created&quot;: &quot;2022-01-10T10:37:41.965626&quot;,
    &quot;userId&quot;: &quot;b0018209-e010-40a0-afe1-00ecd5856c5e&quot;,
    &quot;aircraftId&quot;: &quot;849366e1-cb11-4d72-9034-78b11cd026b0&quot;,
    &quot;liveryId&quot;: &quot;a071518d-995a-4b3c-b65b-656da0d6ed86&quot;,
    &quot;callsign&quot;: &quot;VH-KAI&quot;,
    &quot;server&quot;: &quot;Casual Server&quot;,
    &quot;dayTime&quot;: 2.5355167,
    &quot;nightTime&quot;: 0,
    &quot;totalTime&quot;: 2.5355167,
    &quot;landingCount&quot;: 0,
    &quot;originAirport&quot;: &quot;YTYA&quot;,
    &quot;destinationAirport&quot;: &quot;YTYA&quot;,
    &quot;xp&quot;: 25
  }
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>UserFlight</td>
<td>A flight from the logbook.</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="userflight">
<h4><a class="header-anchor" href="#userflight"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> UserFlight</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>The ID of the flight</td>
</tr>
<tr>
<td><code>created</code></td>
<td>string (datetime)</td>
<td>The time the flight was created</td>
</tr>
<tr>
<td><code>userId</code></td>
<td>string (uuid)</td>
<td>The ID of the user who flew the flight</td>
</tr>
<tr>
<td><code>aircraftId</code></td>
<td>string (uuid)</td>
<td>The ID of the aircraft flown</td>
</tr>
<tr>
<td><code>liveryId</code></td>
<td>string (uuid)</td>
<td>The ID of the livery flown. <strong>This is currently only supported on the Casual server</strong></td>
</tr>
<tr>
<td><code>callsign</code></td>
<td>string</td>
<td>The callsign of the user during this flight</td>
</tr>
<tr>
<td><code>server</code></td>
<td>string</td>
<td>The name of the server the flight was flown on</td>
</tr>
<tr>
<td><code>dayTime</code></td>
<td>float</td>
<td>The flight time during the day, in minutes</td>
</tr>
<tr>
<td><code>nightTime</code></td>
<td>float</td>
<td>The flight time during the night, in minutes</td>
</tr>
<tr>
<td><code>totalTime</code></td>
<td>float</td>
<td>The total flight time of the flight, in minutes</td>
</tr>
<tr>
<td><code>landingCount</code></td>
<td>integer</td>
<td>The number of landings conducted during the flight</td>
</tr>
<tr>
<td><code>originAirport</code></td>
<td>string</td>
<td>The ICAO code of the departure airport. Can be null</td>
</tr>
<tr>
<td><code>destinationAirport</code></td>
<td>string</td>
<td>The ICAO code of the arrival airport. Can be null</td>
</tr>
<tr>
<td><code>xp</code></td>
<td>integer</td>
<td>The number of XP earned during the flight</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get User Flight

<section id="get-user-atc-sessions">
<h1><a class="header-anchor" href="#get-user-atc-sessions"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get User ATC Sessions</h1>
<section class="reference">
<p>Retrieves the ATC session log for a given user.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/users/{userId}/atc</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>userId</code></td>
<td>path</td>
<td>ID of the User</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
<tr>
<td><code>page</code></td>
<td>query</td>
<td>Index of the page to retrieve</td>
<td>No, default <code>1</code></td>
<td>integer</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: {
    &quot;pageIndex&quot;: 1,
    &quot;totalPages&quot;: 80,
    &quot;totalCount&quot;: 791,
    &quot;hasPreviousPage&quot;: false,
    &quot;hasNextPage&quot;: true,
    &quot;data&quot;: [
      {
        &quot;id&quot;: &quot;857b1686-455d-481a-8bdf-c46cd7711691&quot;,
        &quot;atcSessionGroupId&quot;: &quot;1fcff4cb-48e6-46dc-8c87-4202bcdd7cc0&quot;,
        &quot;facility&quot;: {
          &quot;id&quot;: &quot;4fda33c2-91b9-1a57-98f2-a765abd4c019&quot;,
          &quot;airportIcao&quot;: &quot;VRMM&quot;,
          &quot;latitude&quot;: 4.191753387451172,
          &quot;longitude&quot;: 73.52915954589844,
          &quot;frequencyType&quot;: 4
        },
        &quot;created&quot;: &quot;2020-07-03T10:27:08.021137&quot;,
        &quot;updated&quot;: &quot;2020-07-03T10:37:49.026714&quot;,
        &quot;operations&quot;: 9,
        &quot;totalTime&quot;: 86.15142588333333
      },
      ...
    ]
  }
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>PaginatedList</td>
<td>A page from the logbook.</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="paginated-list">
<h4><a class="header-anchor" href="#paginated-list"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Paginated List</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>pageIndex</code></td>
<td>integer</td>
<td>The index of the current page</td>
</tr>
<tr>
<td><code>totalPages</code></td>
<td>integer</td>
<td>The total number of pages available</td>
</tr>
<tr>
<td><code>totalCount</code></td>
<td>integer</td>
<td>The total amount of entries for this dataset</td>
</tr>
<tr>
<td><code>hasPreviousPage</code></td>
<td>boolean</td>
<td>Whether there is a page before this one</td>
</tr>
<tr>
<td><code>hasNextPage</code></td>
<td>boolean</td>
<td>Whether there is a page after this one</td>
</tr>
<tr>
<td><code>data</code></td>
<td>[UserAtcSession]</td>
<td>The entries in the current page</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="useratcsession">
<h4><a class="header-anchor" href="#useratcsession"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> UserAtcSession</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>The ID of the session</td>
</tr>
<tr>
<td><code>atcSessionGroupId</code></td>
<td>string (uuid)</td>
<td>Identifies a group of sessions (for when a controller opens multiple frequencies at the same airport)</td>
</tr>
<tr>
<td><code>facility</code></td>
<td>ATCFacility</td>
<td>Details of the facility that was opened</td>
</tr>
<tr>
<td><code>created</code></td>
<td>string (datetime)</td>
<td>The time at which the frequency was first opened</td>
</tr>
<tr>
<td><code>updated</code></td>
<td>string (datetime)</td>
<td>The time at which last report was received</td>
</tr>
<tr>
<td><code>operations</code></td>
<td>integer</td>
<td>The number of operations earned during the session</td>
</tr>
<tr>
<td><code>totalTime</code></td>
<td>double</td>
<td>The duration of the session in minutes</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="atcfacility">
<h4><a class="header-anchor" href="#atcfacility"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> ATCFacility</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>ID of the ATC Facility</td>
</tr>
<tr>
<td><code>airportIcao</code></td>
<td>string</td>
<td>The ICAO of the airport at which the facility is located</td>
</tr>
<tr>
<td><code>latitude</code></td>
<td>double</td>
<td>Latitude of the ATC Facility</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>double</td>
<td>Longitude of the ATC Facility</td>
</tr>
<tr>
<td><code>frequencyType</code></td>
<td>ATCEntityType</td>
<td>Type of ATC Facility. <em>Enum:</em> <code>&quot;Ground = 0&quot;</code>, <code>&quot;Tower = 1&quot;</code>, <code>&quot;Unicom = 2&quot;</code>, <code>&quot;Clearance = 3&quot;</code>, <code>&quot;Approach = 4&quot;</code>, <code>&quot;Departure = 5&quot;</code>, <code>&quot;Center = 6&quot;</code>, <code>&quot;ATIS = 7&quot;</code>, <code>&quot;Aircraft = 8&quot;</code>, <code>&quot;Recorded = 9&quot;</code>, <code>&quot;Unknown = 10&quot;</code>, <code>&quot;Unused = 11&quot;</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get User ATC Sessions

<section id="get-user-atc-session">
<h1><a class="header-anchor" href="#get-user-atc-session"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get User ATC Session</h1>
<section class="reference">
<p>Retrieves an ATC session from the log of a given user.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/users/{userId}/atc/{atcSessionId}</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>userId</code></td>
<td>path</td>
<td>ID of the User</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
<tr>
<td><code>atcSessionId</code></td>
<td>path</td>
<td>ID of the ATC Session</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: {
    &quot;id&quot;: &quot;857b1686-455d-481a-8bdf-c46cd7711691&quot;,
    &quot;atcSessionGroupId&quot;: &quot;1fcff4cb-48e6-46dc-8c87-4202bcdd7cc0&quot;,
    &quot;facility&quot;: {
        &quot;id&quot;: &quot;4fda33c2-91b9-1a57-98f2-a765abd4c019&quot;,
        &quot;airportIcao&quot;: &quot;VRMM&quot;,
        &quot;latitude&quot;: 4.191753387451172,
        &quot;longitude&quot;: 73.52915954589844,
        &quot;frequencyType&quot;: 4
    },
    &quot;created&quot;: &quot;2020-07-03T10:27:08.021137&quot;,
    &quot;updated&quot;: &quot;2020-07-03T10:37:49.026714&quot;,
    &quot;operations&quot;: 9,
    &quot;totalTime&quot;: 86.15142588333333
  }
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>UserAtcSession</td>
<td>An ATC session from the logbook.</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="useratcsession">
<h4><a class="header-anchor" href="#useratcsession"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> UserAtcSession</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>The ID of the session</td>
</tr>
<tr>
<td><code>atcSessionGroupId</code></td>
<td>string (uuid)</td>
<td>Identifies a group of sessions (for when a controller opens multiple frequencies at the same airport)</td>
</tr>
<tr>
<td><code>facility</code></td>
<td>ATCFacility</td>
<td>Details of the facility that was opened</td>
</tr>
<tr>
<td><code>created</code></td>
<td>string (datetime)</td>
<td>The time at which the frequency was first opened</td>
</tr>
<tr>
<td><code>updated</code></td>
<td>string (datetime)</td>
<td>The time at which last report was received</td>
</tr>
<tr>
<td><code>operations</code></td>
<td>integer</td>
<td>The number of operations earned during the session</td>
</tr>
<tr>
<td><code>totalTime</code></td>
<td>double</td>
<td>The duration of the session in minutes</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="atcfacility">
<h4><a class="header-anchor" href="#atcfacility"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> ATCFacility</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>ID of the ATC Facility</td>
</tr>
<tr>
<td><code>airportIcao</code></td>
<td>string</td>
<td>The ICAO of the airport at which the facility is located</td>
</tr>
<tr>
<td><code>latitude</code></td>
<td>double</td>
<td>Latitude of the ATC Facility</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>double</td>
<td>Longitude of the ATC Facility</td>
</tr>
<tr>
<td><code>frequencyType</code></td>
<td>ATCEntityType</td>
<td>Type of ATC Facility. <em>Enum:</em> <code>&quot;Ground = 0&quot;</code>, <code>&quot;Tower = 1&quot;</code>, <code>&quot;Unicom = 2&quot;</code>, <code>&quot;Clearance = 3&quot;</code>, <code>&quot;Approach = 4&quot;</code>, <code>&quot;Departure = 5&quot;</code>, <code>&quot;Center = 6&quot;</code>, <code>&quot;ATIS = 7&quot;</code>, <code>&quot;Aircraft = 8&quot;</code>, <code>&quot;Recorded = 9&quot;</code>, <code>&quot;Unknown = 10&quot;</code>, <code>&quot;Unused = 11&quot;</code></td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get User ATC Session

<section id="get-notams">
<h1><a class="header-anchor" href="#get-notams"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get NOTAMs</h1>
<section class="reference">
<p>Retrieve a list of all NOTAMs for a session.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/sessions/{sessionId}/notams</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>sessionId</code></td>
<td>path</td>
<td>ID of the session returned from the Sessions endpoint</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;id&quot;: &quot;53671e16-f937-47ca-a5db-c13b6a882851&quot;,
      &quot;title&quot;: &quot;Special Airport Procedures&quot;,
      &quot;author&quot;: &quot;Infinite Flight&quot;,
      &quot;type&quot;: 0,
      &quot;sessionId&quot;: &quot;7e5dcd44-1fb5-49cc-bc2c-a9aab1f6a856&quot;,
      &quot;radius&quot;: 3,
      &quot;message&quot;: &quot;Special Airport Procedures in Effect:\n\nNo straight in approached allowed RWY 13\n\nCC NDB 4500ft - 040° HDG Descending to SC NDB - Visual Right Turn Abeam Checkerboard to RWY 13\n\nPublished Approach Procedures (Found Online) Recommended&quot;,
      &quot;longitude&quot;: 114.20680199460077,
      &quot;latitude&quot;: 22.31646633312086,
      &quot;icao&quot;: &quot;VHHX&quot;,
      &quot;floor&quot;: 0,
      &quot;ceiling&quot;: 10000,
      &quot;startTime&quot;: &quot;2022-02-14T16:34:14.916&quot;,
      &quot;endTime&quot;: &quot;2100-01-01T16:34:00&quot;
    },
    ...
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[NotamResult]</td>
<td>Array of FlightEntry objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="notamresult">
<h4><a class="header-anchor" href="#notamresult"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> NotamResult</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the NOTAM</td>
</tr>
<tr>
<td><code>title</code></td>
<td>string</td>
<td>Short title for NOTAM</td>
</tr>
<tr>
<td><code>author</code></td>
<td>string</td>
<td>Name of NOTAM author</td>
</tr>
<tr>
<td><code>type</code></td>
<td>NotamType</td>
<td>Type of NOTAM. <em>Enum:</em> <code>&quot;NOTAM&quot; = 0, &quot;TFR&quot; = 1</code></td>
</tr>
<tr>
<td><code>sessionId</code></td>
<td>string (uuid)</td>
<td>The ID of the session on which the NOTAM is published. <code>null</code> for all sessions.</td>
</tr>
<tr>
<td><code>radius</code></td>
<td>float</td>
<td>Radius of the NOTAM in NM</td>
</tr>
<tr>
<td><code>message</code></td>
<td>string</td>
<td>Main message for NOTAM</td>
</tr>
<tr>
<td><code>latitude</code></td>
<td>double</td>
<td>Decimal latitude of the center of the NOTAM</td>
</tr>
<tr>
<td><code>longitude</code></td>
<td>double</td>
<td>Decimal longitude of the center of the NOTAM</td>
</tr>
<tr>
<td><code>icao</code></td>
<td>string</td>
<td>ICAO of the nearest airport to the NOTAM</td>
</tr>
<tr>
<td><code>floor</code></td>
<td>integer</td>
<td>Lowest altitude of NOTAM in feet</td>
</tr>
<tr>
<td><code>ceiling</code></td>
<td>integer</td>
<td>Highest altitude of NOTAM in feet</td>
</tr>
<tr>
<td><code>startTime</code></td>
<td>string (datetime)</td>
<td>Time at which the NOTAM comes into effect</td>
</tr>
<tr>
<td><code>endTime</code></td>
<td>string (datetime)</td>
<td>Time at which the NOTAM expires</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get NOTAMs

<section id="get-aircraft">
<h1><a class="header-anchor" href="#get-aircraft"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Aircraft</h1>
<section class="reference">
<p>Retrieve a list of all aircraft models.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/aircraft</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;id&quot;: &quot;81d9ccd4-9c03-493a-811e-8fad3e57bd05&quot;,
      &quot;name&quot;: &quot;A-10&quot;
    },
    ...
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[AircraftPackage]</td>
<td>Array of AircraftPackage objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="aircraftpacakge">
<h4><a class="header-anchor" href="#aircraftpacakge"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> AircraftPacakge</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the model</td>
</tr>
<tr>
<td><code>name</code></td>
<td>string</td>
<td>Name of the aircraft</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Aircraft

<section id="get-aircraft">
<h1><a class="header-anchor" href="#get-aircraft"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get Aircraft</h1>
<section class="reference">
<p>Retrieve a list of all liveries for an aircraft model.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/aircraft/{aircraftId}/liveries</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="parameters">
<h2><a class="header-anchor" href="#parameters"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Parameters</h2>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Located in</th>
<th>Description</th>
<th>Required</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>aircraftId</code></td>
<td>path</td>
<td>ID of the aircraft model returned from the aircraft endpoint</td>
<td>Yes</td>
<td>string (uuid)</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;id&quot;: &quot;701c826b-a160-4b1a-a89f-08d0afb4af1b&quot;,
      &quot;aircraftID&quot;: &quot;710c84ae-6fdc-4c4a-ac3b-4031c3036e98&quot;,
      &quot;aircraftName&quot;: &quot;Airbus A220-300&quot;,
      &quot;liveryName&quot;: &quot;airBaltic&quot;
    },
    ...
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[LiveryData]</td>
<td>Array of LiveryData objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="liverydata">
<h4><a class="header-anchor" href="#liverydata"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveryData</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the livery</td>
</tr>
<tr>
<td><code>aircraftID</code></td>
<td>string (uuid)</td>
<td>ID of the aircraft model</td>
</tr>
<tr>
<td><code>aircraftName</code></td>
<td>string</td>
<td>Name of the aircraft model</td>
</tr>
<tr>
<td><code>liveryName</code></td>
<td>string</td>
<td>Name of the livery</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get Aircraft Liveries

<section id="get-all-liveries">
<h1><a class="header-anchor" href="#get-all-liveries"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Get All Liveries</h1>
<section class="reference">
<p>Retrieve a list of all aircraft liveries.</p>
</section>
<section id="resource">
<h2><a class="header-anchor" href="#resource"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Resource</h2>
<section class="reference">
<p><strong>GET</strong> <code>https://api.infiniteflight.com/public/v2/aircraft/liveries</code></p>
</section>
</section>
<section id="authorization">
<h2><a class="header-anchor" href="#authorization"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Authorization</h2>
<section class="reference">
<p>Include your API key (<code>&lt;apikey&gt;</code>) by either:</p>
<ul>
<li>Adding the <code>apikey</code> query parameter. For example, <code>?apikey=&lt;apikey&gt;</code>.</li>
<li>Sending a bearer authorization header with your API key. For example, <code>Authorization: Bearer &lt;apikey&gt;</code>.</li>
</ul>
</section>
</section>
<section id="response">
<h2><a class="header-anchor" href="#response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Response</h2>
<section class="reference"></section>
<section id="sample-response">
<h4><a class="header-anchor" href="#sample-response"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Sample Response</h4>
<section class="sample">
<pre><code class="language-json">{
  &quot;errorCode&quot;: 0,
  &quot;result&quot;: [
    {
      &quot;id&quot;: &quot;1d7dff42-46a5-4c47-a46c-bd39ab9cea8d&quot;,
      &quot;aircraftID&quot;: &quot;982dd974-5be7-4369-90c6-bd92863632ba&quot;,
      &quot;aircraftName&quot;: &quot;Airbus A318&quot;,
      &quot;liveryName&quot;: &quot;Generic&quot;
    },
    ...
  ]
}
</code></pre>
</section>
<section class="reference"></section>
</section>
<section id="liveapiresponse">
<h4><a class="header-anchor" href="#liveapiresponse"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveAPIResponse</h4>
<section class="reference">
<p><em>Response Type:</em> <code>application/json</code></p>
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>errorCode</code></td>
<td>integer</td>
<td><em>Enum:</em> <code>&quot;Ok = 0&quot;</code>, <code>&quot;UserNotFound = 1&quot;</code>, <code>&quot;MissingRequestParameters = 2&quot;</code>, <code>&quot;EndpointError = 3&quot;</code>, <code>&quot;NotAuthorized = 4&quot;</code>, <code>&quot;ServerNotFound = 5&quot;</code>, <code>&quot;FlightNotFound = 6&quot;</code>, <code>&quot;NoAtisAvailable = 7&quot;</code></td>
</tr>
<tr>
<td><code>result</code></td>
<td>[LiveryData]</td>
<td>Array of LiveryData objects</td>
</tr>
</tbody>
</table></div></section>
</section>
<section id="liverydata">
<h4><a class="header-anchor" href="#liverydata"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> LiveryData</h4>
<section class="reference">
<div class="table-wrapper"><table class="ui table definition unstackable documentation-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td>string (uuid)</td>
<td>Unique identifier for the livery</td>
</tr>
<tr>
<td><code>aircraftID</code></td>
<td>string (uuid)</td>
<td>ID of the aircraft model</td>
</tr>
<tr>
<td><code>aircraftName</code></td>
<td>string</td>
<td>Name of the aircraft model</td>
</tr>
<tr>
<td><code>liveryName</code></td>
<td>string</td>
<td>Name of the livery</td>
</tr>
</tbody>
</table></div></section>
</section>
</section>
</section>


Get All Liveries

<section id="live-api-samples-%26-client-libraries">
<h1><a class="header-anchor" href="#live-api-samples-%26-client-libraries"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Live API Samples &amp; Client Libraries</h1>
<section class="reference">
<p>Below you can find a range of samples in a variety of languages to help you get started with the Live API. Current languages are PHP, NodeJS, Kotlin and C# - but we welcome contributions. Simply Fork and make a Pull Request to <a href="https://github.com/Velocity23/infiniteflightlive-samples" class="documentation-content-link">velocity23/infiniteflightlive-samples</a> on GitHub or get in touch with us on the forum or Discord to get your project added.</p>
<ul>
<li><a href="https://github.com/Velocity23/infiniteflightlive-samples/tree/master/NodeJS" class="documentation-content-link">NodeJS</a></li>
<li><a href="https://github.com/Velocity23/infiniteflightlive-samples/tree/master/C%23" class="documentation-content-link">C#</a></li>
<li><a href="https://github.com/A-FitzGerald/InfiniteLiveKt" class="documentation-content-link">Kotlin</a> (thanks @A-FitzGerald)</li>
<li><a href="https://github.com/Velocity23/infiniteflightlive-samples/tree/master/PHP" class="documentation-content-link">PHP</a></li>
<li><a href="https://github.com/SPEEDBIRD101-CLXVA/InfiniteFlight-LiveApi" class="documentation-content-link">Python</a> (thanks @SPEEDBIRD101)</li>
<li><a href="https://github.com/sqeezelemon/SwiftyLiveApi" class="documentation-content-link">Swift</a> (thanks @sqeezelemon)</li>
<li><a href="https://github.com/sqeezelemon/golive" class="documentation-content-link">Go</a> (thanks @sqeezelemon)</li>
</ul>
</section>
</section>


Samples & Client Libraries

<section id="infinite-flight-opentrack-api">
<h1><a class="header-anchor" href="#infinite-flight-opentrack-api"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Infinite Flight OpenTrack API</h1>
<section class="reference">
<dl>
<dt>NOT AVAILABLE IN 22.6</dt>
<dd>Due to a bug, this API is not available in Infinite Flight 22.6. We'll re-add this in a future app update. Apologies for any inconvenience</dd>
</dl>
<p>The OpenTrack API is an extremely simple UDP API used to control the camera in-game. This function was added in Infinite Flight version 20.2.</p>
</section>
<section id="how-to-use-the-api">
<h2><a class="header-anchor" href="#how-to-use-the-api"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> How to use the API</h2>
<section class="reference">
<p>The OpenTrack API is available on port <code>4242</code>.</p>
<p>To be able to use the OpenTrack API, users must have it enabled. To do this, users can follow these steps.</p>
<dl>
<dt>Step 1</dt>
<dd>Open Infinite Flight</dd>
<dt>Step 2</dt>
<dd>Go into Settings &gt; General</dd>
<dt>Step 3</dt>
<dd>Scroll towards the bottom and look for 'Enable Infinite Flight Connect'</dd>
<dt>Step 4</dt>
<dd>Check the box if it is not checked already</dd>
</dl>
<p>Keep in mind this API is disabled by default.</p>
</section>
</section>
<section id="api-keys">
<h2><a class="header-anchor" href="#api-keys"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> API Keys</h2>
<section class="reference">
<p>No API Key is required for the OpenTrack API.</p>
</section>
</section>
<section id="prerequisites">
<h2><a class="header-anchor" href="#prerequisites"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Prerequisites</h2>
<section class="reference">
<p>This documentation is aimed at someone with knowledge of:</p>
<ul>
<li>User Datagram Protocol (UDP)</li>
<li>Data Types</li>
<li>Camera Axis</li>
</ul>
</section>
</section>
<section id="samples">
<h2><a class="header-anchor" href="#samples"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Samples</h2>
<section class="reference">
<ul>
<li><a href="https://github.com/sqeezelemon/ConnectKit" class="documentation-content-link">ConnectKit</a> - Swift client</li>
</ul>
</section>
</section>
</section>


<section id="set-camera-position">
<h1><a class="header-anchor" href="#set-camera-position"><svg class="permalink" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a> Set Camera Position</h1>
<section class="reference">
<dl>
<dt>NOT AVAILABLE IN 22.6</dt>
<dd>Due to a bug, this API is not available in Infinite Flight 22.6. We'll re-add this in a future app update. Apologies for any inconvenience</dd>
</dl>
<p>To set the Camera Position using the OpenTrack API, send just one chunk with 6 <code>double</code> values in <a href="/guide/developer-reference/connect-api/version-2#little-endian" class="documentation-content-link">Little-Endian</a> format in the following order.</p>
<ul>
<li>X-Axis</li>
<li>Y-Axis</li>
<li>Z-Axis</li>
<li>Yaw</li>
<li>Pitch</li>
<li>Roll</li>
</ul>
<p>The chunk should be sent over UDP to the device running IF on port <code>4242</code>.</p>
</section>
</section>


Set Camera Position

If you're new to Infinite Flight, this is the place to start. We'll get you up and running quickly with our comprehensive Getting Started Guide!

Getting Started Guide

Now that you know your way around the user interface, it's time to take to the skies. Our Flying Guide will help you on your journey to the Expert Server!

Flying Guide

Want to control the aircraft of Infinite Flight? Learn about the user interface with our ATC Guide before moving onto our ATC Manual to learn the rules of controlling!

ATC Guide

Whether you're a qualified controller or just beginning your journey, the ATC Manual will be your rulebook to controlling the skies of Infinite Flight.

ATC Manual

Still having trouble? Our expert support team will get you back up and running in no time.

Get Help

Explore our developer documentation and find out how to extend Infinite Flight with our APIs.

Developer Reference

Help the airports of Infinite Flight come to life with both 2D and 3D editing. This manual is the rulebook on how to use our Scenery Editor within Infinite Flight.

Infinite Flight User Guide

Access to this section is restricted