Git Product home page Git Product logo

navdata's Introduction

NAVAID and AIRPORTS REST API

This project offers a REST API to get information on:

  • Airports
  • Navaid

It currently relies on https://www.github.com/davidmegginson/ourairports-data . Data is refreshed every 24h.

WARNING : NO AIRAC COMPLIANCY

There is no garantee that the provided data is in any way conform to the latest AIRAC cycle.

This data MUST NOT be used to plan real life flights.

Usage

Environment parameters

  • HOST : host the http server is listening to. Default is 127.0.0.1
  • PORT : port the http server is listening to. Default is 8080
  • TOKEN_LIST : a comma separated list of accepted connexion tokens for security purpose. Token muse be provided as navaid_auth_token. If not set, token verification is bypassed
  • DATABASE_PATH : the path to SQLite database. Defaut is :memory, which means not persistent

API

  • GET /airport?search={query} : look for an airport based on query string. Answer first 100 results
  • GET /airport/{icao} : look for an airport based on its ICAO code
  • GET /navaid?search={query} : look for a navaid (VOR, DME, ADF...) based on query string. Answer first 100 results
  • GET /navaid/{icao} : look for an navaid based on its ICAO code

Config file

Config files must be given for docker as /config/config.yaml.

Format is:

http:
  host: 127.0.0.1
  port: 8080
security:
  auth_tokens:
    - aaaa
    - bbbb
    - cccc
database:
  backend : MONGODB # can be either SQLITE or MONGODB
  path : mongodb://localhost:27017 # Mongo URI if mongo (mandatory. Path to sqlite file if sqlite. If sqlite and no path, memory is used

navdata's People

Contributors

leirn avatar

Watchers

 avatar  avatar

navdata's Issues

Add search key to API

Some filters are needed on the api

First instance, limite the search to a specific country

Add "nearest" function

Offer a way to request the nth airports or navaids that are the closest to specific lat/lon coordinates

Add index the the dabatase

Currently no index are defined except for primary keys.

To speed up search, index are required in several places

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.