Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

Commit

Permalink
Update readme.md for archiving the repo
Browse files Browse the repository at this point in the history
  • Loading branch information
niczem authored Aug 31, 2023
1 parent 24feeda commit a698c38
Showing 1 changed file with 1 addition and 87 deletions.
88 changes: 1 addition & 87 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,89 +1,3 @@
# AIS API

I looked for a free API solution to access machine readable AIS Data. This solution uses the free web solutions to crawl the data and returns them in json.

## How to use

This is a nodejs web app.

### Paths

#### /getLastPosition/:mmsi

Takes position from MT and from VT and returns the newest
example: http://localhost:5000/getLastPosition/211281610

#### /getLastPositionFromVF/:mmsi

Returns position from VF
example: http://localhost:5000/getLastPositionFromVF/211281610

#### /getLastPositionFromMT/:mmsi

Returns position from MT
example: http://localhost:5000/getLastPositionFromMT/211281610

#### /getVesselsInArea/:area

Returns all vessels in area, defined by a list of area keywords
example: http://localhost:5000/getVesselsInArea/WMED,EMED

#### /getVesselsNearMe/:lat/:lng/:distance

Returns all vessels near me, defined by a location in latitude, longitude, and distance
example: http://localhost:5000/getVesselsNearMe/51.74190/3.89773/2

```Javascript
[{
name: vessel.SHIPNAME,
id: vessel.SHIP_ID,
lat: Number(vessel.LAT),
lon: Number(vessel.LON),
timestamp: vessel.LAST_POS,
mmsi: vessel.MMSI,
imo: vessel.IMO,
callsign: vessel.CALLSIGN,
speed: Number(vessel.SPEED),
area: vessel.AREA_CODE,
type: vessel.TYPE_SUMMARY,
country: vessel.COUNTRY,
destination: vessel.DESTINATION,
port_current_id: vessel.PORT_ID,
port_current: vessel.CURRENT_PORT,
port_next_id: vessel.NEXT_PORT_ID,
port_next: vessel.NEXT_PORT_NAME,
},…]
```

#### /getVesselsInPort/:shipPort

Returns all vessels in a port, named after the MT nomenclature
example: http://localhost:5000/getVesselsInPort/piraeus

Output format identical to **getVesselsInArea**

## Install on local machine

Requirements: npm & nodejs.

1. clone this repo

2. run `npm install`

3. run `node index.js`

## Install as docker container

Requirements: docker

1. `docker build -t ais-api .`

2. `docker run -p 5000:5000 ais-api`

## Deploy to heroku

This application can be easily deployed to heroku, simply install the heroku cli and run the following commands:

`heroku create`

`git push heroku master`
This repo is discontinued. Please use [github.com/transparency-everywhere/position-api/](https://github.com/transparency-everywhere/position-api/) in future =)

0 comments on commit a698c38

Please sign in to comment.