README.md

Crown Network Crawler

Setup

Requirements

• Docker
• Docker-Compose

Build

sudo docker-compose -f compose.yaml build

Run

sudo docker-compose -f compose.yaml up

Endpoints

• Peer Count

  Retrieves the amount of nodes reached by the crawler

  • /api/v1/

  Returns <int:peer_count>

• Peers

  Retrieves the data of all peers reached by the crawler, paginated by 20 records

  • /api/v1/peers

  Query Params

  • page: int
    • Example: /api/v1/peers?page=1

  Returns <json:peers_data>