Documentation

In progress — full API + methodology docs land alongside GA.

We're rolling documentation out gradually as the platform matures. If a topic below has no linked page yet, email [email protected] and we'll answer in-line and prioritise the docs page.

Methodology

The scoring engine is an AHP-weighted composite of per-species tolerance envelopes fit against published peer-reviewed literature. Every envelope traces to a primary citation surfaced in the run's compliance report. Full methodology write-up in progress.

Oysters

Five species covered: Ostrea edulis (European native), Crassostrea virginica (Eastern), Crassostrea gigas (Pacific), Ostrea lurida (Olympia), Crassostrea gasar (Tunisian / West African). Backed by the oystermapR R package on CRAN.

Corals

Eight cold-water species (Lophelia, gorgonians, black corals, stylasterids) via coldcoralmapR. Twelve warm-water species (Caribbean + Indo-Pacific, several IUCN-listed) via warmcoralmapR.

Bivalves

13 species across hard clams, soft-shell, surf, cockles, giant clams, razor, geoduck. Five mussel species. Pinna nobilis and other pen shells. Species distributions fit against NOAA usSEABED, EMODnet, and regional grab-sample archives.

Freshwater mussels

19 species: 14 North American natives (including US-endangered Snuffbox, Purple Wartyback, Fat Pocketbook) plus 5 invasives (Zebra, Quagga, Golden, Asian clam, Nile perch). Shipped in freshwatermusselmapR v0.1.0.

REST API

The full REST API reference — authentication, envelope CRUD, run submission, result download, webhook contracts — is available at {API_BASE_URL}/docs once you're signed in. OpenAPI 3.1 spec at {API_BASE_URL}/openapi.json. Enterprise customers get a hosted SDK reference; ask [email protected].

Citations and methodology

Every scoring run's compliance report includes an inline citation block covering: species tolerance sources, regulatory overlay attribution (CMEMS, NOAA WOA, GEBCO, EMODnet, ETOPO), and Folk-5 sediment taxonomy references. The full canonical bibliography is embedded in each report and available on request.

Missing something? Email [email protected]. We answer within one business day.