Source for https://api.ooni.io/

File bugs with the API inside of: https://github.com/ooni/backend/issues/new

• Docker
• Make
• Python >= 3.5
• Postgresql

Note: the default database configuration is postgres@localhost:15432/ooni_measurements, you only need to run the second step below (export DATABASE_URL) in case you want to use a different one.

tox -e run

# Monitor the generated metrics
watch -n1 -d 'curl -s http://127.0.0.1:5000/metrics'

# Call the API
curl http://127.0.0.1:5000/api/v1/measurements?since=2019-01-01&until=2019-02-01&limit=1

Run the integration tests:

tox -q -e integ

# Run only test_list_measurements* tests, stop on first failure, monitor file changes and rerun failed tests
tox -q -e integ -k test_list_measurements -x -f

Clone the API repository.

Set up a local database or a port forwarding.

ssh amsmetadb.ooni.nu  -L 0.0.0.0:15432:127.0.0.1:5432 -Snone -g -C

Create a new test in tests/integ/test_integration.py and run it with:

tox -e integ -- -s --show-capture=no -k test_bug_12345_blah

Fix the bug and send a pull request for the bugfix and test together.

Thanks!