Skip to content
Go 1.21+ · Cross-platform · SimBrief API

simbrief

Go library for SimBrief — fetch and decode OFPs in JSON v2 or XML, read the take-off and landing speeds of the runway analysis, and build the dispatch URLs that create new plans.

$ go get github.com/mrlm-net/simbrief
At a glance
OFP formats JSON v2 · XML
API key none
Packages client · types
Dependencies stdlib only
Go 1.21+
fetches from SimBrief's public /api/xml.fetcher.php

What it does

Your SimBrief plan, typed, in your Go program

Fetch any OFP

The latest plan of a user by user ID or username, or exactly one plan by its static ID, from SimBrief's public fetcher.

JSON v2 and XML

Both formats decode into the same FlightPlanResponse. Golden tests decode a real OFP in each.

The whole OFP

ATC flight plan, aircraft, fuel, weights, times, weather, alternates with their own navlogs, the navlog fixes, files and links.

Take-off and landing speeds

V1, VR, V2, flaps, thrust and flex temperature for the planned runway, and the dry or wet landing Vref, from the runway analysis.

Numbers as SimBrief sends them

types.Number keeps the raw text ("0365", ".57", "") with Int, Float, Bool and IsSet, so "missing" and "0" stay apart.

Dispatch URLs

A fluent FlightPlanBuilder and validation for new plans: open the URL in a browser logged in to SimBrief, then fetch the plan by its static ID.

Back open-source MSFS tooling

Support the project

Sponsoring covers infrastructure costs, development time, and the simulator licences needed to test the mrlm-net flight simulation libraries against the real thing.

Sponsor via Revolut