├── .github ├── workflow │ └── docker.yml └── workflows │ └── docker.yml ├── .gitignore ├── Dockerfile ├── LICENSE.md ├── README.md ├── package.json ├── src └── Main.ts └── tsconfig.json /.github/workflow/docker.yml: -------------------------------------------------------------------------------- 1 | name: Docker 2 | 3 | on: 4 | push: 5 | branches: [ "main" ] 6 | tags: [ 'v*.*.*' ] 7 | pull_request: 8 | branches: [ "main" ] 9 | 10 | env: 11 | REGISTRY: ghcr.io 12 | IMAGE_NAME: ${{ github.repository }} 13 | 14 | 15 | permissions: 16 | contents: read 17 | packages: write 18 | 19 | jobs: 20 | build: 21 | runs-on: ubuntu-latest 22 | 23 | steps: 24 | - name: Checkout repository 25 | uses: actions/checkout@v3 26 | - name: Extract Docker metadata 27 | id: meta 28 | uses: docker/metadata-action@v4.3.0 29 | with: 30 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} 31 | - name: Setup Docker buildx 32 | uses: docker/setup-buildx-action@v2.4.0 33 | - name: Log into registry ${{ env.REGISTRY }} 34 | if: github.event_name != 'pull_request' 35 | uses: docker/login-action@v2.1.0 36 | with: 37 | registry: ${{ env.REGISTRY }} 38 | username: ${{ github.actor }} 39 | password: ${{ secrets.GITHUB_TOKEN }} 40 | - name: Build and push Docker image 41 | id: build-and-push 42 | uses: docker/build-push-action@v4.0.0 43 | with: 44 | context: . 45 | push: ${{ github.event_name != 'pull_request' }} 46 | tags: ${{ steps.meta.outputs.tags }} 47 | labels: ${{ steps.meta.outputs.labels }} 48 | -------------------------------------------------------------------------------- /.github/workflows/docker.yml: -------------------------------------------------------------------------------- 1 | name: Docker 2 | 3 | on: 4 | push: 5 | branches: [ "main" ] 6 | tags: [ 'v*.*.*' ] 7 | pull_request: 8 | branches: [ "main" ] 9 | 10 | env: 11 | REGISTRY: ghcr.io 12 | IMAGE_NAME: ${{ github.repository }} 13 | 14 | 15 | permissions: 16 | contents: read 17 | packages: write 18 | 19 | jobs: 20 | build: 21 | runs-on: ubuntu-latest 22 | 23 | steps: 24 | - name: Checkout repository 25 | uses: actions/checkout@v3 26 | - name: Extract Docker metadata 27 | id: meta 28 | uses: docker/metadata-action@v4.3.0 29 | with: 30 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} 31 | - name: Setup Docker buildx 32 | uses: docker/setup-buildx-action@v2.4.0 33 | - name: Log into registry ${{ env.REGISTRY }} 34 | if: github.event_name != 'pull_request' 35 | uses: docker/login-action@v2.1.0 36 | with: 37 | registry: ${{ env.REGISTRY }} 38 | username: ${{ github.actor }} 39 | password: ${{ secrets.GITHUB_TOKEN }} 40 | - name: Build and push Docker image 41 | id: build-and-push 42 | uses: docker/build-push-action@v4.0.0 43 | with: 44 | context: . 45 | push: ${{ github.event_name != 'pull_request' }} 46 | tags: ${{ steps.meta.outputs.tags }} 47 | labels: ${{ steps.meta.outputs.labels }} 48 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | dist/ 3 | 4 | node_modules/ 5 | 6 | package-lock.json 7 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:18-alpine 2 | 3 | WORKDIR /server 4 | 5 | COPY package.json tsconfig.json ./ 6 | 7 | RUN npm i && npm i typescript -g 8 | 9 | COPY src/ ./src 10 | 11 | EXPOSE 3000 12 | 13 | ENV NODE_ENV = production 14 | 15 | CMD ["npm", "start"] -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "{}" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright {yyyy} {name of copyright owner} 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Docker Build Status](https://github.com/ADSB-One/api/actions/workflows/docker.yml/badge.svg) 2 | # ADSB One API 3 | 4 | The ADSB One API lives at https://api.adsb.one. Use the table below for endpoints. To make switching easy, all responses conform to the ADSBExchange v2 API. 5 | 6 | # Endpoints 7 | **NOTE**: Replace `[var]` with your value. Do not include the brackets in your API call. 8 | 9 | | Endpoint | Method | Description | 10 | -----------|--------|---------------- 11 | | /v2/hex/[hex] | GET | Return all aircraft with an exact match on one of the given Mode S hex ids (limited to 1000) | 12 | | /v2/callsign/[callsign] | GET | Returns all aircraft with an exact match on one of the given callsigns (limited to 1000 or 8000 characters for the request) | 13 | | /v2/reg/[reg] | GET | Returns all aircraft with an exact match on one of the given registrations (limited to 1000 or 8000 characters for the request) | 14 | | /v2/type/[type] | GET | Returns all aircraft that have one of the specified ICAO type codes (A321, B738, etc.) | 15 | | /v2/squawk/[squawk] | GET | Returns all aircraft that are squawking the specified value | 16 | | /v2/mil/ | GET | Returns all aircraft tagged as military | 17 | | /v2/ladd/ | GET | Returns all aircraft tagged as LADD | 18 | | /v2/pia/ | GET | Returns all aircraft tagged as PIA | 19 | | /v2/point/[lat]/[lon]/[radius] | GET | Returns all aircraft within a certain radius of a given point up to 250 nm | 20 | 21 | ## Example Usage 22 | `curl https://api.adsb.one/v2/hex/A9CEE9` 23 | 24 | ```json 25 | {"ac":[{"hex":"a9cee9","type":"adsb_icao","flight":"N731BP ","alt_baro":38000,"alt_geom":38275,"gs":338.9,"track":276.1,"baro_rate":0,"squawk":"3301","emergency":"none","category":"A2","nav_qnh":1013.6,"nav_altitude_mcp":38016,"nav_heading":280.55,"nav_modes":["autopilot","althold","lnav"],"lat":37.358322,"lon":-93.374147,"nic":9,"rc":75,"seen_pos":3.486,"version":2,"nic_baro":1,"nac_p":10,"nac_v":2,"sil":3,"sil_type":"perhour","gva":2,"sda":3,"alert":0,"spi":0,"mlat":[],"tisb":[],"messages":24844,"seen":0.7,"rssi":-15.8}],"msg":"No error","now":1675633671226,"total":1,"ctime":1675633671226,"ptime":0} 26 | ``` 27 | 28 | ## Rate Limiting 29 | The ADSB One API is rate limited to 1 request per second. 30 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "api", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "start": "ts-node src/Main.ts" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/ADSB-One/api.git" 12 | }, 13 | "author": "Huusky", 14 | "license": "Apache 2.0", 15 | "bugs": { 16 | "url": "https://github.com/ADSB-One/api/issues" 17 | }, 18 | "homepage": "https://github.com/ADSB-One/api#readme", 19 | "devDependencies": { 20 | "@tsconfig/node18-strictest": "^1.0.0", 21 | "@types/cors": "^2.8.13", 22 | "@types/express": "^4.17.16", 23 | "@types/node": "^18.11.18", 24 | "ts-node": "^10.9.1", 25 | "typescript": "^4.9.5" 26 | }, 27 | "dependencies": { 28 | "axios": "^1.3.2", 29 | "cors": "^2.8.5", 30 | "express": "^4.18.2" 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/Main.ts: -------------------------------------------------------------------------------- 1 | import axios from 'axios'; 2 | import * as CORS from 'cors'; 3 | import * as Express from 'express'; 4 | 5 | const server = Express.default(); 6 | 7 | server.use(CORS.default()); 8 | 9 | const readsb_api_host = process.env['READSB_API_HOST'] || 'readsb_hub'; 10 | const readsb_api_port = process.env['READSB_API_PORT'] || '30006'; 11 | 12 | 13 | // Get one or more aircraft based on Mode S hex code 14 | server.get('/v2/hex/:hex', async (req: any, res) => { 15 | var hex = req.params.hex; 16 | 17 | var hexRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?find_hex=${hex}&jv2`); 18 | hexRes = JSON.stringify(hexRes.data); 19 | 20 | res.type('json'); 21 | res.send(hexRes); 22 | }); 23 | 24 | // Get one or more aircraft based on callsign 25 | server.get('/v2/callsign/:callsign', async (req: any, res) => { 26 | var callsign = req.params.callsign; 27 | 28 | var callsignRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?find_callsign=${callsign}&jv2`); 29 | 30 | res.type('json'); 31 | res.send(callsignRes); 32 | }); 33 | 34 | // Get one or more aircraft based on registration 35 | server.get('/v2/reg/:reg', async (req: any, res) => { 36 | var reg = req.params.reg; 37 | 38 | var regRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?find_reg=${reg}&jv2`); 39 | 40 | res.type('json'); 41 | res.send(regRes); 42 | }); 43 | 44 | // Get one or more aircraft based on ICAO type code 45 | server.get('/v2/type/:type', async (req: any, res) => { 46 | var type = req.params.type; 47 | 48 | var typeRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?find_type=${type}&jv2`); 49 | 50 | res.type('json'); 51 | res.send(typeRes); 52 | }); 53 | 54 | // Get one or more aircraft based on squawk 55 | server.get('/v2/squawk/:squawk', async (req: any, res) => { 56 | var squawk = req.params.squawk; 57 | 58 | var squawkRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?all&filter_squawk=${squawk}&jv2`); 59 | 60 | res.type('json'); 61 | res.send(squawkRes); 62 | }); 63 | 64 | // Get all currently tracked military aircraft 65 | server.get('/v2/mil/', async (_req: any, res) => { 66 | var milRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?all&filter_mil&jv2`); 67 | 68 | res.type('json'); 69 | res.send(milRes); 70 | }); 71 | 72 | // Get all currently tracked LADD aircraft 73 | server.get('/v2/ladd/', async (_req: any, res) => { 74 | var laddRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?all&filter_ladd&jv2`); 75 | 76 | res.type('json'); 77 | res.send(laddRes); 78 | }); 79 | 80 | // Get all currently tracked PIA aircraft 81 | server.get('/v2/pia/', async (_req: any, res) => { 82 | var piaRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?all&filter_pia&jv2`); 83 | 84 | res.type('json'); 85 | res.send(piaRes); 86 | }); 87 | 88 | // Get all aircraft within a point in a certain radius 89 | server.get('/v2/point/:lat/:lon/:rad', async (req: any, res) => { 90 | var lat = req.params.lat; 91 | var lon = req.params.lon; 92 | var rad = req.params.rad; 93 | rad > 250 ? rad = 250 : rad = rad; 94 | 95 | var pointRes: any = await axios.get(`http://${readsb_api_host}:${readsb_api_port}/re-api/?circle=${lat},${lon},${rad}&jv2`); 96 | 97 | res.type('json'); 98 | res.send(pointRes); 99 | }); 100 | 101 | server.listen(3000, () => { 102 | console.info('ADSB One API server started.') 103 | }); 104 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "@tsconfig/node18-strictest", 3 | "compilerOptions": { 4 | "rootDir": "./src", /* Specify the root folder within your source files. */ 5 | "outDir": "./dist", /* Specify an output folder for all emitted files. */ 6 | } 7 | } 8 | --------------------------------------------------------------------------------