# `ZenQuant.OrderBook`
[🔗](https://github.com/ZenHive/zen_quant/blob/v0.8.1/lib/zen_quant/order_book.ex#L1)

Shared order-book level contract for ZenQuant consumers.

A readable level is either an exact two-element `[price, size]` list or a map
with numeric `:price` and `:size`, `:amount`, or `:quantity` fields. String
keys are accepted. Consumers return
`{:error, {:invalid_orderbook_level, offending_level}}` for any other shape.

# `level`

```elixir
@type level() :: {number(), number()}
```

Numeric price and size read from an order-book level

# `level_error`

```elixir
@type level_error() :: {:error, {:invalid_orderbook_level, term()}}
```

Error returned when an order-book level cannot be read

---

*Consult [api-reference.md](api-reference.md) for complete listing*