### GET /bars-packages Source: https://docs.stopbars.com/api-reference/data/list-current-bars-data-packages Retrieves public metadata for installer MSFS data packages, including size, hash, and timestamps. ```APIDOC ## GET /bars-packages ### Description Retrieves public metadata for installer MSFS data packages, including size, hash, and timestamps. ### Method GET ### Endpoint /bars-packages ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **Package metadata** (any) - Package metadata returned #### Response Example ```json { "example": "Package metadata returned" } ``` ``` -------------------------------- ### Installer API Source: https://context7_llms Endpoints for managing product releases and download statistics. ```APIDOC ## Get download statistics (per product) ### Description Retrieves download statistics for a specific product. ### Method GET ### Endpoint /api/installer/products/{productId}/download-stats ### Parameters #### Path Parameters - **productId** (string) - Required - The unique identifier of the product. ### Response #### Success Response (200) - **stats** (object) - Download statistics for the product. ## Get latest release for a product ### Description Retrieves information about the latest release of a specific product. ### Method GET ### Endpoint /api/installer/products/{productId}/latest-release ### Parameters #### Path Parameters - **productId** (string) - Required - The unique identifier of the product. ### Response #### Success Response (200) - **release** (object) - Details of the latest release. ## List all product releases (optionally filtered) ### Description Retrieves a list of all releases for a product, with optional filtering. ### Method GET ### Endpoint /api/installer/products/{productId}/releases ### Parameters #### Path Parameters - **productId** (string) - Required - The unique identifier of the product. #### Query Parameters - **version** (string) - Optional - Filter releases by a specific version. - **channel** (string) - Optional - Filter releases by a specific channel (e.g., 'stable', 'beta'). ### Response #### Success Response (200) - **releases** (array) - A list of release objects for the product. ## Record a product download ### Description Increments the download counter for the latest release of a given product. An IP address is only counted once per product and version within a rolling 24-hour window. ### Method POST ### Endpoint /api/installer/products/{productId}/download ### Parameters #### Path Parameters - **productId** (string) - Required - The unique identifier of the product. #### Request Body - **version** (string) - Required - The version of the product being downloaded. ### Request Example { "version": "1.2.3" } ``` -------------------------------- ### GET /faqs Source: https://docs.stopbars.com/api-reference/faq/list-public-faqs Retrieves a list of public FAQs available through the Stopbars API. ```APIDOC ## GET /faqs ### Description Retrieves a list of public FAQs. ### Method GET ### Endpoint /faqs ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **FAQs** (any) - A list of FAQs returned. #### Response Example ```json { "FAQs": [ { "question": "What is Stopbars?", "answer": "Stopbars is a platform for..." } ] } ``` ``` -------------------------------- ### Get Latest Release OpenAPI Spec Source: https://docs.stopbars.com/api-reference/installer/get-latest-release-for-a-product OpenAPI specification for the GET /releases/latest endpoint. This spec defines how to request the latest release for a given product. It includes details on request parameters, response schemas for success (200) and not found (404) cases, and available servers. The 'product' query parameter is an enum with a list of supported products. ```yaml https://v2.stopbars.com/openapi.json get /releases/latest paths: path: /releases/latest method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: product: schema: - type: enum enum: - Pilot-Client - vatSys-Plugin - EuroScope-Plugin - Installer - SimConnect.NET required: true header: {} cookie: {} body: {} response: '200': _mintlify/placeholder: schemaArray: - type: any description: Latest release returned examples: {} description: Latest release returned '404': _mintlify/placeholder: schemaArray: - type: any description: Not found examples: {} description: Not found deprecated: false type: path components: schemas: {} ``` -------------------------------- ### GET /downloads/stats Source: https://docs.stopbars.com/api-reference/installer/get-download-statistics-per-product Retrieves download statistics for products. If a product is specified, stats for that product are returned. Otherwise, stats for all products are returned, including a combined total. ```APIDOC ## GET /downloads/stats ### Description Retrieves download statistics for products. If a product is specified, stats for that product are returned. Otherwise, stats for all products are returned, including a combined total. ### Method GET ### Endpoint /downloads/stats ### Parameters #### Query Parameters - **product** (enum) - Optional - The product for which to retrieve statistics. Allowed values are: Pilot-Client, vatSys-Plugin, EuroScope-Plugin, Installer, SimConnect.NET. ### Request Example ```json { "message": "No request body needed for this GET request." } ``` ### Response #### Success Response (200) - **stats** (any) - An array of objects, where each object contains download statistics for a product. If a specific product was requested, this will be an array with a single object. Includes a `combinedTotal` if all products are requested. #### Response Example ```json { "stats": [ { "product": "Pilot-Client", "downloads": 1500 }, { "product": "vatSys-Plugin", "downloads": 1200 }, { "combinedTotal": 2700 } ] } ``` ``` -------------------------------- ### OpenAPI Specification for GET /contributions Source: https://docs.stopbars.com/api-reference/contributions/list-contributions This OpenAPI specification defines the GET /contributions endpoint. It details the request parameters (status, airport, user) and the expected response for listing contributions. The endpoint is available on production and local development servers. ```yaml paths: path: /contributions method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: status: schema: - type: string airport: schema: - type: string user: schema: - type: string header: {} cookie: {} body: {} response: '200': _mintlify/placeholder: schemaArray: - type: any description: Contributions listed examples: {} description: Contributions listed deprecated: false type: path components: schemas: {} ``` -------------------------------- ### GET /state - Get current lighting/network state Source: https://docs.stopbars.com/api-reference/state/get-current-lightingnetwork-state Returns the current lighting and network state for a single airport or all airports. An option is available to format the output for VATSIM Radar. ```APIDOC ## GET /state ### Description Returns state for a single airport or all airports. Use `airport=vatsimradar` for VATSIM Radar format (objects include `lights`; `offline` omitted; offline airports excluded). ### Method GET ### Endpoint /state ### Parameters #### Query Parameters - **airport** (string) - Required - ICAO (4 chars) or `all`. Use `vatsimradar` for VATSIM Radar format. - **offline** (boolean) - Optional - Force offline state response regardless of connected controllers ### Request Example ```json { "airport": "KJFK", "offline": false } ``` ### Response #### Success Response (200) - **state** (any) - State returned #### Response Example ```json { "airport_states": [ { "airport": "KJFK", "lights": { "runway_1l": "red", "runway_1r": "red" }, "offline": false } ] } ``` #### Error Response (400) - **error** (any) - Missing or invalid airport parameter ``` -------------------------------- ### GET /divisions Source: https://docs.stopbars.com/api-reference/divisions/list-all-divisions Retrieves a list of all divisions. Requires a VATSIM authentication token. ```APIDOC ## GET /divisions ### Description Retrieves a list of all available divisions. This endpoint is used to fetch division data from the Stopbars API. ### Method GET ### Endpoint /divisions ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "message": "Example request body (if any)" } ``` ### Response #### Success Response (200) - **divisions** (array) - A list of division objects, where each object contains division details. #### Response Example ```json { "divisions": [ { "id": "D1", "name": "Example Division 1" }, { "id": "D2", "name": "Example Division 2" } ] } ``` #### Error Response (401) - **error** (string) - "Unauthorized" or a similar message indicating missing or invalid authentication. #### Error Response Example ```json { "error": "Unauthorized: Invalid or missing VATSIM token" } ``` ### Security - **X-Vatsim-Token** (apiKey) - Required header parameter for VATSIM authentication. Obtain this token via OAuth callback. ``` -------------------------------- ### Get OpenAPI Specification (YAML) Source: https://docs.stopbars.com/api-reference/system/get-openapi-specification Fetches the OpenAPI 3.0 document for the BARS Core API. This YAML definition describes the available API endpoints, including paths, HTTP methods, server URLs, request parameters, and response schemas. ```yaml paths: path: /openapi.json method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: {} header: {} cookie: {} body: {} response: '200': application/json: schemaArray: - type: object properties: {} examples: example: value: {} description: OpenAPI document deprecated: false type: path components: schemas: {} ``` -------------------------------- ### GET /openapi.json Source: https://docs.stopbars.com/api-reference/system/get-openapi-specification Retrieves the current OpenAPI 3.0 document for the BARS Core API. This specification details all available endpoints, their parameters, request/response formats, and authentication methods. ```APIDOC ## GET /openapi.json ### Description Returns the current OpenAPI 3.0 document for the BARS Core API. ### Method GET ### Endpoint /openapi.json ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **application/json** (object) - The OpenAPI 3.0 document specifying the BARS Core API. #### Response Example ```json { "openapi": "3.0.0", "info": { "title": "BARS Core API", "version": "1.0.0" }, "paths": { "/openapi.json": { "get": { "summary": "Get OpenAPI specification", "responses": { "200": { "description": "OpenAPI document", "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` ``` -------------------------------- ### GET /airports/{icao}/points Source: https://docs.stopbars.com/api-reference/points/list-lightingnavigation-points-for-airport Retrieves a list of lighting and navigation points for a specific airport identified by its ICAO code. ```APIDOC ## GET /airports/{icao}/points ### Description Retrieves a list of lighting and navigation points for a specific airport. ### Method GET ### Endpoint /airports/{icao}/points ### Parameters #### Path Parameters - **icao** (string) - Required - The ICAO code of the airport (exactly 4 characters). #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **Points returned** (any) - A list of lighting and navigation points. #### Response Example ```json { "points": [ { "type": "runway_centerline_light", "coordinates": [ -73.9857, 40.7484 ] }, { "type": "navigation_beacon", "coordinates": [ -73.9857, 40.7484 ] } ] } ``` #### Error Response (400) - **Invalid ICAO** (any) - Returned if the provided ICAO code is invalid. ``` -------------------------------- ### Get Latest Release for a Product Source: https://docs.stopbars.com/api-reference/installer/get-latest-release-for-a-product Retrieves the latest release information for a specified product. This endpoint supports different products and returns details about their most recent releases. ```APIDOC ## GET /releases/latest ### Description Retrieves the latest release information for a specified product. ### Method GET ### Endpoint /releases/latest ### Parameters #### Query Parameters - **product** (enum) - Required - The product for which to retrieve the latest release. Possible values: Pilot-Client, vatSys-Plugin, EuroScope-Plugin, Installer, SimConnect.NET ### Request Example ```json { "product": "Pilot-Client" } ``` ### Response #### Success Response (200) - **any** - Latest release returned #### Response Example ```json { "version": "1.2.3", "releaseDate": "2023-10-27T10:00:00Z", "notes": "Bug fixes and performance improvements." } ``` #### Error Response (404) - **any** - Not found ``` -------------------------------- ### Get OpenAPI Specification Source: https://context7_llms Retrieves the OpenAPI 3.0 specification document for the BARS Core API. ```APIDOC ## GET /system/get-openapi-specification ### Description Returns the current OpenAPI 3.0 document for the BARS Core API. ### Method GET ### Endpoint /system/get-openapi-specification ### Parameters No parameters required. ### Request Example ``` GET /system/get-openapi-specification ``` ### Response #### Success Response (200 OK) - Returns the OpenAPI 3.0 specification in JSON format. #### Response Example ```json { "openapi": "3.0.0", "info": { "title": "BARS Core API", "version": "1.0.0" }, "paths": { ... } } ``` ``` -------------------------------- ### GET /stateid/info.json Source: https://docs.stopbars.com/api-reference/state/static-mapping-of-state-ids-to-light-colors Returns a lightweight, static list of light state codes and their direction colors. ```APIDOC ## GET /stateid/info.json ### Description Returns a lightweight, static list of light state codes and their direction colors. ### Method GET ### Endpoint /stateid/info.json ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **Mapping returned** (any) - Mapping returned #### Response Example ```json { "mapping": [ { "stateId": "some_state_id", "color": "#RRGGBB", "direction": "North" } ] } ``` ``` -------------------------------- ### GET /contributions/top-packages Source: https://docs.stopbars.com/api-reference/contributions/get-most-used-packages Retrieves statistics for the most used packages within the Stopbars LLMs TXT project. ```APIDOC ## GET /contributions/top-packages ### Description Retrieves statistics for the most used packages. ### Method GET ### Endpoint https://v2.stopbars.com/contributions/top-packages ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **stats** (any) - Package stats returned #### Response Example ```json { "stats": "Package stats returned" } ``` ``` -------------------------------- ### OpenAPI Specification for /stateid/info.json Source: https://docs.stopbars.com/api-reference/state/static-mapping-of-state-ids-to-light-colors This OpenAPI specification defines the GET endpoint /stateid/info.json, which retrieves information about state IDs and their associated light direction colors. It includes details on production and local development servers, request parameters, and the response format. ```yaml paths: path: /stateid/info.json method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: {} header: {} cookie: {} body: {} response: '200': _mintlify/placeholder: schemaArray: - type: any description: Mapping returned examples: {} description: Mapping returned deprecated: false type: path components: schemas: {} ``` -------------------------------- ### GET /points/{id} Source: https://docs.stopbars.com/api-reference/points/get-a-single-point-by-id Retrieves a single point by its unique identifier. ```APIDOC ## GET /points/{id} ### Description Retrieves a single point by its unique identifier. ### Method GET ### Endpoint /points/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the point. #### Query Parameters None. #### Request Body None. ### Request Example None. ### Response #### Success Response (200) - **point** (any) - Information about the found point. #### Response Example ```json { "point": "Point found" } ``` #### Error Response (404) - **error** (any) - Indicates that the point was not found. #### Error Response Example ```json { "error": "Not found" } ``` ``` -------------------------------- ### OpenAPI Specification for Listing vatSys Profiles Source: https://docs.stopbars.com/api-reference/vatsys/list-public-vatsys-profile-xmls This snippet provides the OpenAPI specification for the GET `/vatsys/profiles` endpoint. It details the server URLs, request parameters, and the structure of the successful response, which lists profiles. ```yaml paths: path: /vatsys/profiles method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: {} header: {} cookie: {} body: {} response: '200': _mintlify/placeholder: schemaArray: - type: any description: Profiles listed examples: {} description: Profiles listed deprecated: false type: path components: schemas: {} ``` -------------------------------- ### OpenAPI Specification for /docs Endpoint Source: https://docs.stopbars.com/api-reference/system/redirect-to-api-documentation This OpenAPI specification describes the `/docs` endpoint for the Stopbars API. It details the GET method, available servers for production and local development, and the expected 302 redirect response pointing to docs.stopbars.com. No request body or specific parameters are defined for this endpoint. ```yaml https://v2.stopbars.com/openapi.json get /docs paths: path: /docs method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: {} header: {} cookie: {} body: {} response: '302': _mintlify/placeholder: schemaArray: - type: any description: Redirect to docs.stopbars.com examples: {} description: Redirect to docs.stopbars.com deprecated: false type: path components: schemas: {} ``` -------------------------------- ### GET /divisions/{id} Source: https://docs.stopbars.com/api-reference/divisions/get-division-details Retrieves details for a specific division using its ID. Requires a VATSIM authentication token. ```APIDOC ## GET /divisions/{id} ### Description Retrieves details for a specific division by its unique identifier. This endpoint is used to fetch information about a particular division within the Stopbars system. ### Method GET ### Endpoint `/divisions/{id}` ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the division to retrieve. #### Query Parameters None #### Request Body None ### Request Example ```yaml https://v2.stopbars.com/divisions/123 Headers: X-Vatsim-Token: "your-vatsim-token" ``` ### Response #### Success Response (200) - **Division object** (any) - Details of the requested division. #### Response Example ```json { "id": 123, "name": "Example Division", "...other_division_details...": "..." } ``` #### Error Response (404) - **Error object** (any) - Indicates that the division was not found. #### Error Response Example ```json { "message": "Division not found" } ``` ``` -------------------------------- ### OpenAPI Specification for Contributions Leaderboard Source: https://docs.stopbars.com/api-reference/contributions/get-top-contributors This OpenAPI specification defines the GET /contributions/leaderboard endpoint. It includes server URLs for different environments and describes the expected response format for retrieving the leaderboard. No security or complex parameters are required for this endpoint. ```yaml https://v2.stopbars.com/openapi.json get /contributions/leaderboard paths: path: /contributions/leaderboard method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: {} header: {} cookie: {} body: {} response: '200': _mintlify/placeholder: schemaArray: - type: any description: Leaderboard returned examples: {} description: Leaderboard returned deprecated: false type: path components: schemas: {} ``` -------------------------------- ### GET /contributions/user Source: https://docs.stopbars.com/api-reference/contributions/get-current-users-contributions Retrieves the current user's contributions. Supports filtering by status and pagination. ```APIDOC ## GET /contributions/user ### Description Retrieves the current user's contributions. Supports filtering by status and pagination. ### Method GET ### Endpoint /contributions/user ### Parameters #### Path Parameters None #### Query Parameters - **status** (string) - Optional - Filters contributions by their status. - **page** (integer) - Optional - The page number for pagination. Minimum value is 1. - **limit** (integer) - Optional - The number of contributions per page. Minimum value is 1. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **Contributions** (any) - An array of contribution objects. #### Response Example ```json { "Contributions": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "userId": "user-123", "status": "completed", "createdAt": "2023-10-27T10:00:00Z", "updatedAt": "2023-10-27T11:00:00Z" } ] } ``` ``` -------------------------------- ### GET /divisions/user Source: https://docs.stopbars.com/api-reference/divisions/get-divisions-for-current-user Retrieves a list of divisions associated with the currently authenticated user. Authentication is handled via a VATSIM token. ```APIDOC ## GET /divisions/user ### Description Retrieves a list of divisions associated with the currently authenticated user. ### Method GET ### Endpoint https://v2.stopbars.com/divisions/user ### Parameters #### Header Parameters - **X-Vatsim-Token** (apiKey) - Required - VATSIM authentication token obtained via OAuth callback. ### Response #### Success Response (200) - **User divisions** (any) - User divisions returned #### Response Example ```json { "example": "[User divisions returned]" } ``` ``` -------------------------------- ### Get Current Lighting/Network State Source: https://context7_llms Retrieves the current lighting and network state for a specified airport or all airports. Supports a special format for VATSIM Radar data. ```APIDOC ## GET /state/get-current-lightingnetwork-state ### Description Returns state for a single airport or all airports. Use `airport=vatsimradar` for VATSIM Radar format (objects include `lights`; `offline` omitted; offline airports excluded). ### Method GET ### Endpoint /state/get-current-lightingnetwork-state ### Parameters #### Query Parameters - **airport** (string) - Optional - ICAO code for the airport (4 characters). If not provided, returns state for all airports. Use `vatsimradar` for VATSIM Radar format. ### Request Example ``` GET /state/get-current-lightingnetwork-state?airport=KJFK ``` ### Response #### Success Response (200 OK) - Returns a JSON object containing the airport state, including lighting and network information. #### Response Example ```json { "airport_icao": "KJFK", "state": { "lights": { "rwys": [ { "id": "04R", "state": 1, "color": "green" } ], "taxiways": [] }, "network_status": "online" } } ``` ``` -------------------------------- ### GET /notam Source: https://docs.stopbars.com/api-reference/notam/get-global-notam Retrieves the current global NOTAM information. This endpoint provides real-time NOTAM data relevant to aviation. ```APIDOC ## GET /notam ### Description Retrieves the current global NOTAM information. This endpoint provides real-time NOTAM data relevant to aviation. ### Method GET ### Endpoint /notam ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **any** - Current NOTAM returned #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get latest approved BARS map XML Source: https://docs.stopbars.com/api-reference/generation/get-latest-approved-bars-map-xml-raw-content-for-an-airport-&-package Retrieves the raw content of the latest approved BARS map XML for a specified airport (ICAO code) and package. ```APIDOC ## GET /maps/{icao}/packages/{package}/latest ### Description Retrieves the raw content of the latest approved BARS map XML for a specified airport (ICAO code) and package. ### Method GET ### Endpoint `/maps/{icao}/packages/{package}/latest` ### Parameters #### Path Parameters - **icao** (string) - Required - The ICAO code of the airport. - **package** (string) - Required - The identifier for the package. #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **body** (application/xml) - The BARS XML document returned inline. #### Response Example ```xml ``` #### Error Response (404) - **body** (any) - Not found. ``` -------------------------------- ### GET /auth/account Source: https://docs.stopbars.com/api-reference/auth/get-authenticated-account-information Retrieves authenticated account information using a VATSIM token. Supports different responses for account found, invalid token, banned user, or user not found. ```APIDOC ## GET /auth/account ### Description Retrieves the authenticated user's account information. Requires a VATSIM authentication token. ### Method GET ### Endpoint /auth/account ### Parameters #### Header Parameters - **X-Vatsim-Token** (apiKey) - Required - VATSIM authentication token obtained via OAuth callback. ### Request Example (No request body for this GET request) ### Response #### Success Response (200) - **Account found** (any) - Represents a successful retrieval of account details. #### Error Responses - **401** - Missing or invalid token - **403** - User is banned - **404** - User not found #### Response Example (200 OK) ```json { "message": "Account found" } ``` #### Response Example (401 Unauthorized) ```json { "message": "Missing or invalid token" } ``` #### Response Example (403 Forbidden) ```json { "message": "User is banned" } ``` #### Response Example (404 Not Found) ```json { "message": "User not found" } ``` ``` -------------------------------- ### GET /points Source: https://docs.stopbars.com/api-reference/points/get-multiple-points-by-ids Retrieves multiple points by their IDs. This endpoint allows fetching a list of point data based on a comma-separated list of unique point identifiers. ```APIDOC ## GET /points ### Description Retrieves multiple points by their IDs. This endpoint allows fetching a list of point data based on a comma-separated list of unique point identifiers. ### Method GET ### Endpoint /points ### Parameters #### Query Parameters - **ids** (string) - Required - Comma-separated list of point IDs (max 100) ### Request Example ```json { "query": { "ids": "id1,id2,id3" } } ``` ### Response #### Success Response (200) - **Points returned** (any) - Description of the points data returned. #### Response Example ```json { "points": [ { "id": "id1", "name": "Point 1", "location": "..." }, { "id": "id2", "name": "Point 2", "location": "..." } ] } ``` #### Error Response (400) - **Validation error** (any) - Description of the validation error. ``` -------------------------------- ### GET /divisions/{id}/airports Source: https://docs.stopbars.com/api-reference/divisions/list-division-airports Retrieves a list of airports for a specified division. Requires a VATSIM authentication token. ```APIDOC ## GET /divisions/{id}/airports ### Description Retrieves a list of airports for a specified division using its ID. This endpoint requires authentication via a VATSIM token. ### Method GET ### Endpoint /divisions/{id}/airports ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the division. #### Query Parameters None #### Header Parameters - **X-Vatsim-Token** (apiKey) - Required - VATSIM authentication token obtained via OAuth callback. ### Request Example ```json { "example": "GET /divisions/123/airports" } ``` ### Response #### Success Response (200) - **airports** (array) - A list of airports within the specified division. The exact structure of each airport object is not detailed here but is expected to be of type 'any'. #### Error Response (404) - **error** (string) - Indicates that the division was not found. #### Response Example (200) ```json { "airports": [ { "iata": "LAX", "name": "Los Angeles International Airport" }, { "iata": "SFO", "name": "San Francisco International Airport" } ] } ``` #### Response Example (404) ```json { "error": "Division not found" } ``` ``` -------------------------------- ### OpenAPI Specification for /contributors Endpoint Source: https://docs.stopbars.com/api-reference/github/list-github-contributors This OpenAPI YAML defines the GET /contributors endpoint for the Stopbars v2 API. It specifies the server URLs for production and local development, request parameters (empty in this case), and the response structure for a successful retrieval of contributors. No specific authentication is required for this endpoint. ```yaml https://v2.stopbars.com/openapi.json get /contributors paths: path: /contributors method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: {} header: {} cookie: {} body: {} response: '200': _mintlify/placeholder: schemaArray: - type: any description: Contributors returned examples: {} description: Contributors returned deprecated: false type: path components: schemas: {} ``` -------------------------------- ### List Division Airports API (OpenAPI) Source: https://docs.stopbars.com/api-reference/divisions/list-division-airports This OpenAPI specification defines the GET /divisions/{id}/airports endpoint. It requires a VATSIM authentication token and returns a list of airports for a specified division ID. The endpoint supports production and local development environments. ```yaml paths: path: /divisions/{id}/airports method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: - title: VatsimToken parameters: query: {} header: X-Vatsim-Token: type: apiKey description: VATSIM authentication token obtained via OAuth callback. cookie: {} parameters: path: id: schema: - type: integer required: true query: {} header: {} cookie: {} body: {} response: '200': _mintlify/placeholder: schemaArray: - type: any description: Airports listed examples: {} description: Airports listed '404': _mintlify/placeholder: schemaArray: - type: any description: Division not found examples: {} description: Division not found deprecated: false type: path components: schemas: {} ``` -------------------------------- ### POST /download Source: https://docs.stopbars.com/api-reference/installer/record-a-product-download Increments the download counter for the latest release of a specified product. IP addresses are counted once per product and version within a 24-hour rolling window. ```APIDOC ## POST /download ### Description Increments the download counter for the latest release of the given product. A given IP is only counted once per product+version within a rolling 24 hour window. After 24h the same IP can increment again. ### Method POST ### Endpoint /download ### Parameters #### Query Parameters - **product** (enum) - Required - The product for which to record a download. Allowed values: Pilot-Client, vatSys-Plugin, EuroScope-Plugin, Installer, SimConnect.NET #### Request Body This endpoint does not require a request body. ### Request Example ```json { "product": "Pilot-Client" } ``` ### Response #### Success Response (200) - **any** - Download recorded (or already counted for this IP) #### Error Response (400) - **any** - Missing product or invalid product #### Error Response (404) - **any** - Latest release not found when version omitted ``` -------------------------------- ### List Product Releases OpenAPI Specification Source: https://docs.stopbars.com/api-reference/installer/list-all-product-releases-optionally-filtered This OpenAPI specification defines the `/releases` endpoint for retrieving a list of product releases. It supports optional filtering by product name. The endpoint requires no authentication and returns a 200 status code with a list of releases. It is available on production and local development servers. ```yaml https://v2.stopbars.com/openapi.json get /releases paths: path: /releases method: get servers: - url: https://v2.stopbars.com description: Production - url: http://localhost:8787 description: Local development (wrangler dev) request: security: [] parameters: path: {} query: product: schema: - type: enum enum: - Pilot-Client - vatSys-Plugin - EuroScope-Plugin - Installer - SimConnect.NET header: {} cookie: {} body: {} response: '200': _mintlify/placeholder: schemaArray: - type: any description: Releases listed examples: {} description: Releases listed deprecated: false type: path components: schemas: {} ``` -------------------------------- ### Redirect to API documentation Source: https://docs.stopbars.com/api-reference/system/redirect-to-api-documentation Redirects to the hosted API documentation site. ```APIDOC ## GET /docs ### Description Redirects to the hosted API documentation site. ### Method GET ### Endpoint /docs ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (302) - **redirect** (any) - Redirects to docs.stopbars.com #### Response Example (See OpenAPI specification for detailed response examples. Typically a 302 redirect.) ``` -------------------------------- ### Redirect to API Documentation Source: https://context7_llms Redirects the user to the hosted API documentation website. ```APIDOC ## GET /system/redirect-to-api-documentation ### Description Redirects to the hosted API documentation site. ### Method GET ### Endpoint /system/redirect-to-api-documentation ### Parameters No parameters required. ### Request Example ``` GET /system/redirect-to-api-documentation ``` ### Response #### Success Response (302 Found) - Redirects to the documentation URL. #### Response Example ``` HTTP/1.1 302 Found Location: https://docs.stopbars.com/ ``` ``` -------------------------------- ### List Product Releases Source: https://docs.stopbars.com/api-reference/installer/list-all-product-releases-optionally-filtered Retrieves a list of all product releases. This endpoint can be optionally filtered by product name. ```APIDOC ## GET /releases ### Description Retrieves a list of all product releases. This endpoint can be optionally filtered by product name. ### Method GET ### Endpoint /releases ### Parameters #### Query Parameters - **product** (enum) - Optional - Filters releases by product name. Allowed values: Pilot-Client, vatSys-Plugin, EuroScope-Plugin, Installer, SimConnect.NET ### Request Example ```json { "example": "No request body for GET request" } ``` ### Response #### Success Response (200) - **releases** (array) - A list of product release objects. - **name** (string) - The name of the release. - **version** (string) - The version of the release. - **published_at** (string) - The date and time the release was published. #### Response Example ```json { "releases": [ { "name": "Pilot-Client", "version": "1.2.0", "published_at": "2023-10-27T10:00:00Z" }, { "name": "vatSys-Plugin", "version": "0.5.1", "published_at": "2023-10-26T15:30:00Z" } ] } ``` ``` -------------------------------- ### FAQ API Source: https://context7_llms Endpoint for listing public Frequently Asked Questions. ```APIDOC ## List public FAQs ### Description Retrieves a list of publicly available Frequently Asked Questions. ### Method GET ### Endpoint /api/faq ### Response #### Success Response (200) - **faqs** (array) - A list of FAQ objects, each containing a question and an answer. ``` -------------------------------- ### Data API Source: https://context7_llms Endpoints for retrieving data packages. ```APIDOC ## List current BARS data packages ### Description Public metadata for installer MSFS data packages (models & removals). Returns size, hash, and timestamps. ### Method GET ### Endpoint /api/data/bars-packages ### Response #### Success Response (200) - **packages** (array) - A list of BARS data package objects, including name, size, hash, and timestamps. ``` -------------------------------- ### GET /airports/nearest Source: https://docs.stopbars.com/api-reference/airports/find-nearest-airport Retrieves the nearest airport to a given latitude and longitude. Results are cached for performance. ```APIDOC ## GET /airports/nearest ### Description Returns the nearest airport to a given latitude/longitude. Results are cached in 5NM buckets for high performance. ### Method GET ### Endpoint /airports/nearest ### Parameters #### Query Parameters - **lat** (number) - Required - Latitude in decimal degrees (-90 to 90) - **lon** (number) - Required - Longitude in decimal degrees (-180 to 180) ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **any** - Nearest airport returned #### Response Example ```json { "example": "Nearest airport returned" } ``` #### Error Responses - **400** - Invalid coordinates - **404** - No airport found ``` -------------------------------- ### Authentication API Source: https://context7_llms Endpoints for managing user authentication and API keys. ```APIDOC ## Delete current user account ### Description Deletes the currently authenticated user's account. ### Method DELETE ### Endpoint /api/auth/account ## Get authenticated account information ### Description Retrieves information about the currently authenticated user. ### Method GET ### Endpoint /api/auth/account ### Response #### Success Response (200) - **userId** (string) - The unique identifier for the user. - **username** (string) - The username of the user. - **email** (string) - The email address of the user. ### Response Example { "userId": "user123", "username": "testuser", "email": "test@example.com" } ## Regenerate API key ### Description Generates a new API key for the authenticated user. There is a 24-hour cooldown period between requests. ### Method POST ### Endpoint /api/auth/regenerate-api-key ### Response #### Success Response (200) - **apiKey** (string) - The newly generated API key. ### Response Example { "apiKey": "new_api_key_string" } ## Update preferred display name mode ### Description Updates the preferred display name mode for the authenticated user. ### Method PUT ### Endpoint /api/auth/display-name-mode ### Parameters #### Request Body - **mode** (string) - Required - The preferred display name mode (e.g., 'first_name', 'full_name'). ### Request Example { "mode": "first_name" } ## VATSIM OAuth callback ### Description Exchanges an authorization code for a VATSIM token and redirects to the frontend with the token. ### Method GET ### Endpoint /api/auth/vatsim-oauth/callback ### Parameters #### Query Parameters - **code** (string) - Required - The authorization code received from VATSIM. ### Response #### Success Response (302 Found) Redirects to the frontend with a token in the URL parameters. ``` -------------------------------- ### GET /divisions/{id}/members Source: https://docs.stopbars.com/api-reference/divisions/list-division-members Retrieves a list of members belonging to a specific division. Requires VATSIM authentication. ```APIDOC ## GET /divisions/{id}/members ### Description Retrieves a list of members belonging to a specific division. Authentication is required. ### Method GET ### Endpoint https://v2.stopbars.com/divisions/{id}/members ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the division. #### Query Parameters None. #### Header Parameters - **X-Vatsim-Token** (apiKey) - Required - VATSIM authentication token obtained via OAuth callback. ### Request Example ```json { "example": "No request body for GET request" } ``` ### Response #### Success Response (200) - **Members listed** (any) - Description of the response body detailing the members. #### Response Example ```json { "example": "[\n {\n \"id\": 123,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n }\n]" } ``` #### Error Response (404) - **Division not found** (any) - Description indicating that the specified division was not found. ``` -------------------------------- ### List Public vatSys Profile XMLs Source: https://context7_llms Lists the public XML profile files available for vatSys. ```APIDOC ## GET /vatsys/list-public-vatsys-profile-xmls ### Description List public vatSys profile XMLs. ### Method GET ### Endpoint /vatsys/list-public-vatsys-profile-xmls ### Parameters No parameters required. ### Request Example ``` GET /vatsys/list-public-vatsys-profile-xmls ``` ### Response #### Success Response (200 OK) - Returns a list of URLs to public vatSys profile XML files. #### Response Example ```json [ "https://stopbars.com/vatsys/profiles/default.xml", "https://stopbars.com/vatsys/profiles/custom.xml" ] ``` ```