Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Edouard Barrault committed Nov 11, 2024
1 parent 5a40819 commit 75d2088
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,9 @@ The Terraform setup work:
- install NGinx with the required configurations
- implement a Letsencrypt certificate with Certbot

NB: The last point is currently disabled
as a DNSSEC issue related to the created IPs or DNS records
is still in the way (Scaleway support WIP).

<br>

### APIs
### API endpoints

When using Docker, you can access the APIs via the following queries:

Expand All @@ -101,6 +97,12 @@ curl -s "http://localhost:3000/transactions/by-value?address=0x9702230A8Ea53601f
curl -s "http://localhost:3000/transactions/count?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7
```

When fully deployed, you can access the APIs via the following URLs:

- List of transactions: http://localhost:3000/transactions?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7&page=2&limit=5
- List of transactions sorted by value: http://localhost:3000/transactions/by-value?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7&page=2&limit=5
- Transactions count: http://localhost:3000/transactions/count?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7

<br>

### Linting + Pre-commit
Expand Down

0 comments on commit 75d2088

Please sign in to comment.