diff --git a/README.md b/README.md index aabdf307..82fe25b5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ # IDEA-DeFi-CRAFT + Repository containing work on the IDEA DeFi project for the CRAFT grant issued for the duration of June 2022-May 2023. + +# DeFi Data Engine Rest API + +The data engine endpoint lives at [**http://defi-de.idea.rpi.edu:8080/defi/v1/rest**](http://defi-de.idea.rpi.edu:8080/defi/v1/rest){.uri} + +## Current Paths + +### /source_exists + +| ?param | desc | +|--------|------| +| source | | + +### /stream_exists + +| ?param | desc | +|--------|------| +| key | | + +### /initialize + +| ?param | desc | +|-----------|------| +| source | | +| auth_data | | + +### /is_authorized + +| ?param | desc | +|--------|------| +| key | | + +### /is_active + +| ?param | desc | +|--------|------| +| key | | + +### /request_dated + +| ?param | desc | +|-------------|------| +| destination | | +| key | | +| request | | +| query | | +| start_date | | +| end_date | |