johrpan/ubigen
1
0
Fork 0
mirror of https://github.com/johrpan/ubigen.git synced 2025-10-26 19:57:24 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add API example application

Browse source
This commit is contained in:
Elias Projahn 2022-12-16 15:03:25 +01:00
parent 254c43b016
commit 673bad39f7
2 changed files with 83 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
inst/content/api.md
View file

@ -1,3 +1,11 @@
## API access
Ubigen provides programmatic access via an HTTP API. Please see the
documentation below which includes usage examples using the commonly available
command [cURL](https://curl.se/). There is also an exemplary
[Python script](https://code.johrpan.de/johrpan/ubigen/src/branch/main/scripts/api_example.py)
to show how to use the API in your own applications.
## Using the API for retrieving the data
You can use the API endpoint `/ranking` to download the dataset formatted in