# README

exccwebapi

exccwebapi implements a simple HTTP API which provides summary data about the ExchangeCoin blockchain and ecosystem. Some data such as a list of Voting Service Providers is hard-coded, and some is collected from external sources such as GitHub and exccdata.

Voting Service Providers

Data from exccwebapi is used to populate the VSP list of both decred.org and Exilibrium.

To add a new VSP to the API, VSP operators must open a pull request on this repository after following the operator guidelines and coordinating with the ExchangeCoin community.

API

API calls are documented in api.md.

Docker

To build the image:

docker build -t exccco/exccwebapi .

By default, the container exposes port 8080. To run the image:

docker run --rm -d -p [local port]:8080 exccco/exccwebapi

License

exccwebapi is licensed under the copyfree ISC License.

# Functions

NewService

NewService creates a new dcrwebapi service.

NormalizeBuildString

NormalizeBuildString returns the passed string stripped of all characters which are not valid according to the semantic versioning guidelines for build metadata strings.

# Constants

StakepoolAPICurrentVersion

StakepoolAPICurrentVersion is the current stakepool API version.

StakepoolAPIInitialVersion

StakepoolAPIInitialVersion is the initial stakepool API version.

# Structs

Service

Service represents a dcrweb service.

Stakepool

Stakepool represents a decred stakepool solely for voting delegation.

Vsp

Vsp contains information about a single Voting Service Provider.

# Type aliases

StakepoolSet

StakepoolSet represents a collection of stakepools.