osm-stats-api

User facing API for Missing Maps statistics.

Starting locally

You could run

docker-compose up

or follow the steps listed here.

1. Clone local copies

   git clone [email protected]:AmericanRedCross/osm-stats-api.git

   git clone [email protected]:AmericanRedCross/osm-stats-workers.git

2. Get the Postgres server running on your machine

   pg_ctl -D /usr/local/var/postgres start

3. Add env variables

   export OVERPASS_URL=<overpass url>:6080

   export DATABASE_URL=postgresql:///osm_stats_2

4. npm i pgexplode

5. Run make db/all

6. Connect to psql -d osm_stats_2

7. Fetch value from http://overpass-api.de/api/augmented_diff_status

8. From psql run update augmented_diff_status set id = <value from earlier step> - 10

9. Fetch value from https://planet.osm.org/replication/changesets/state.yaml

10. From psql run update changesets_status set id = <value from earlier step> - 10

11. Switch to osm-stats-workers directory and run

`npm run housekeeping`

`npm run update-badges`

`npm install`

`npm start`

12. Get back to osm-stats-api and run npm start. This should give you the local api link

Runtime Dependencies

• Redis
• PostgreSQL (referenced via DATABASE_URL)

API Endpoints and Documentation

• /stats/{hashtag?}
• /users
• /users/{user_id#}
• /hashtags
• /group-summaries/{hashtag-name-1, hashtag-name-2, ...}
• /top-users/{hashtag-name}
• /hashtags/{hashtag-name}/map
• /countries
• /countries/{country-code}
• /countries/{country-code}/hashtags
• /countries/{country-code}/users

All endpoints and additional documentation can be found in the osm-stats API documentation.