API Reference DpExchangeCore v#0.1.4

Copy Markdown View Source

Modules

The DpExchange family: one identical facade over every trading venue.

The conformance suite every venue package runs in its own CI.

The generic, venue-agnostic symbol normaliser.

A venue's capability declaration — the return of DpExchange.Core.Venue.capabilities/0, and the thing a consumer branches on instead of on venue identity.

Resolves a configurable seam, per process rather than per node.

Behavior defining the interface for cryptocurrency exchange data providers.

An in-process rate limiter, and the default implementation of DpExchange.Core.RateLimitBehaviour.

A venue's price feed: symbols in, price events out. How is the venue's business.

The shared HTTP request pipeline: rate limiting, retry, logging, error shaping and the generic authentication schemes.

One listing as the VENUE describes it: canonical symbol, base, quote, instrument type and trading status.

What a venue package says about itself — distinct from what a venue says about the market, and never carrying market data.

A feed built from repeated fetches, for a venue package to use INSIDE its own feed.

Behaviour for the rate-limit token-bucket implementation that every exchange adapter calls before making an API request.

The symbol-normalisation contract every venue package must satisfy.

Standardised :telemetry event names that every venue package emits. A consumer attaches to these names without coupling to any particular venue's implementation — which is what makes one metrics dashboard work across the whole family.

The canonical timeframe vocabulary: a string label, its width in seconds, and the boundary every real candle of that width sits on.

Normalised balance entry, returned by every venue package.

Normalised order fill — a partial or complete execution of the caller's own order.

Normalised order, returned by every venue package.

Normalised order book snapshot, returned by every venue package.

Normalised price quote, returned by every venue package.

Normalised public trade — anyone's order match, from the venue's trade tape.

The facade. The single module a consumer touches, identical on every venue.