Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexmaryin/ourairports_json

Web service for JSON responsing of airports data from ourairports.com
https://github.com/alexmaryin/ourairports_json

Last synced: 21 days ago
JSON representation

Web service for JSON responsing of airports data from ourairports.com

Host: GitHub
URL: https://github.com/alexmaryin/ourairports_json
Owner: alexmaryin
Created: 2021-11-30T10:44:09.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2021-12-21T06:50:05.000Z (about 3 years ago)
Last Synced: 2024-04-20T17:50:41.381Z (8 months ago)
Language: Kotlin
Size: 7.18 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

OurAirports2Json

Web service for JSON responsing of airports data from https://ourairports.com/

Allows to receive World airports information in JSON format originated from https://ourairports.com

Best way to try API online and discover it is Swagger documentation

## Disclaimer
*Please don't use this API as an officially supported information for the purposes of real flight-planning. Information grabbed here has been created and maintains
by whole-the-world community and may contains out of dated details for airports, radio frequencies and runways conditions.*

## Base URL

Deployed on Amazon Cloud `http://ec2-13-51-70-132.eu-north-1.compute.amazonaws.com`

Delpoyed on Heroku Cloud `https://ourairports-json.herokuapp.com`

## Authentication

API doesn't require any authentication.

## Routes

### Airports

Return Airport with radio frequencies and runways details.

* Get airports JSON details `/api/v1/airports/:icao` where `icao` is 4-letter ICAO code of airport

### Runways

Return runways details for airport with specified ICAO.

* Get runways JSON array for concerned airport `/api/v1/runways/:icao` where `icao` is 4-letter ICAO code of airport

### Frequencies

Return radio details for airport with specified ICAO.

* Get radio JSON array for concerned airport `/api/v1/frequencies/:icao` where 'icao' is 4-letter ICAO code of airport

### Response status

* `200 OK` if success
* `400 Bad request` if icao code isn't correct
* `404 Not found` if API database hasn't any details of required airport

## Schemas

### Airport
```json
"Airport": {
"icao": {
"type": "string",
},
"type": {
"type": "string",
"enum": ["closed_airport", "heliport", "large_airport", "medium_airport", "seaplane_base", "small_airport"],
},
"name": {
"type": "string",
},
"latitude": {
"type": "number",
},
"longitude": {
"type": "number",
},
"elevation": {
"type": "integer",
"format": "int32",
},
"webSite": {
"type": "string",
},
"wiki": {
"type": "string",
},
"frequencies": [
"items": "Frequency"
],
"runways": [
"items": "Runway"
]
}
```
Airport type may have one of the following values:
* closed_airport
* heliport
* large_airport
* medium_airport
* seaplane_base
* small_airport

### Runways
```json
"Runway": {
"lengthFeet": {
"type": "integer",
"format": "int32",
},
"widthFeet": {
"type": "integer",
"format": "int32",
},
"surface": {
"type": "string",
"enum": ["ASP", "TURF", "CON", "GRS","GRE", "WATER","UNK"],
},
"closed": {
"type": "boolean"
},
"lowNumber": {
"type": "string",
},
"lowElevationFeet": {
"type": "integer",
"format": "int32",
},
"lowHeading": {
"type": "integer",
"format": "int32",
},
"highNumber": {
"type": "string",
},
"highElevationFeet": {
"type": "integer",
"format": "int32",
},
"highHeading": {
"type": "integer",
"format": "int32",
}
}
```
Surface type may have one of the following values:
* ASP - asphalt
* TURF - turf
* CON - concrete
* GRS - grass
* GRE - gravel
* WATER - water
* UNK - unknown

### Frequency
```json
"Frequency": {
"type": {
"type": "string",
"enum": ["TML", "CTAF", "CTR", "AFIS", "APP", "RMP", "ARR", "ATIS", "UNIC", "DEL", "CTR", "DEP", "FIRE", "GND", "TWR", "UNKNOWN"],
},
"description": {
"type": "string",
},
"valueMhz": {
"type": "number",
"format": "float",
}
}
```
Frequency type may have one of the following values:
* TML - terminal area
* CTAF - flight advisory service
* CTR - radar/control area
* UNKNOWN
* AFIS - flight information service
* APP - approach
* RMP - apron
* ARR - arrival
* ATIS - weather observation automatic service
* UNIC - unicom
* DEL - delivery
* DEP - departure
* FIRE - emergency service
* GND - ground
* TWR - tower

## License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.