Creatures API

Overview

Read-only public data from Creatures. Responses are identical for every anonymous caller. Clients ignore unknown fields, tolerate unknown enum values and kinds, treat ids as opaque, follow moved answers and keep paging while has_more is true. Do not depend on field order or ranking. Sync passes do not report deletions or records that become hidden: a client that caches must re-validate each item with GET at least every 24 hours, and a 404 means remove it. Every error is application/problem+json (RFC 9457). v1 changes are additive only.

Base URL: https://creatures.com/api/v1. No API key or Creatures account is needed for public reads.

Browser GET and HEAD requests support CORS with Access-Control-Allow-Origin: *. See the OpenAPI document for the complete machine-readable contract.

Rate limits and errors

Anonymous REST requests are limited to 60 per minute and 1000 per hour, per IP address. A 429 response includes Retry-After: wait that many seconds before retrying. Errors use application/problem+json with a status, code and human-readable detail. Rate-limit responses also include RateLimit and RateLimit-Policy headers.

Terms

Use of the API is covered by the Creatures Terms and Privacy Policy.

Endpoints

GET `/api/v1/listings`

List public animal listings

Parameters
Parameter	Location, type and description
`status`	query; optional `string; one of ["active","sold","all"]` active (default): listings for sale, as on /marketplace. sold: sold listings, as on /marketplace/sold, most recently sold first. all: every lot of one event that passes the listing get gate, in the organizer's order; only with event, and with no other filter or sort.
`q`	query; optional `string; min length 1; max length 100` Free text, 1-100 characters.
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).
`breed`	query; optional `string; min length 1; max length 100` Breed id (<species>.<breed>), a bare breed slug with species, or a name.
`sex`	query; optional `string; one of ["male","female","unknown"]`
`sale_type`	query; optional `string; one of ["fixed_price","auction"]`
`state`	query; optional `string; min length 2; max length 60` US state or Canadian province (code or name).
`near`	query; optional `string; min length 2; max length 100` A place the user is asking about, e.g. 'Austin, TX'; not the caller's own location.
`radius_mi`	query; optional `integer; min 1; max 500`
`price_min`	query; optional `integer; min 0; max 10000000000` Minor units (cents).
`price_max`	query; optional `integer; min 0; max 10000000000` Minor units (cents).
`registered`	query; optional `boolean`
`event`	query; optional `string; pattern ^[0-9A-Za-z]{8}$` A sale_event id.
`seller`	query; optional `string; pattern ^(user:\|org:\|org_)[0-9A-Za-z]{8}$` The account the listing is sold under: user:<id>, org:<id> or breeder org_<id>. A member listing an org-owned animal uses the member user:<id>, even when the displayed seller is the org.
`updated_since`	query; optional `string; format date-time`
`sync_after`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`sort`	query; optional `string; one of ["newest","ending_soon","price_asc","price_desc","recently_sold","relevance"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.listing
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-watermark, sync-reset, unknown-filter, ambiguous-filter, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable, search-unavailable.

GET `/api/v1/listings/{id}`

Get one public listing

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK listing.full
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/animals`

List public animals

Parameters
Parameter	Location, type and description
`q`	query; optional `string; min length 1; max length 100` Free text, 1-100 characters.
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).
`breed`	query; optional `string; min length 1; max length 100` Breed id (<species>.<breed>), a bare breed slug with species, or a name.
`sex`	query; optional `string; one of ["male","female","unknown"]`
`state`	query; optional `string; min length 2; max length 60` US state or Canadian province (code or name).
`registered`	query; optional `boolean`
`has_listing`	query; optional `boolean` true: has an active public listing.
`born_from`	query; optional `integer; min 1900; max 2100`
`born_to`	query; optional `integer; min 1900; max 2100`
`updated_since`	query; optional `string; format date-time`
`sync_after`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`sort`	query; optional `string; one of ["newest","name","updated"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.animal
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-watermark, sync-reset, unknown-filter, ambiguous-filter, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/animals/{id}`

Get one public animal

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK animal.full
301: Moved: this id was replaced by the resource named in Location and moved_to. common.problem
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/breeders`

List public breeders

Parameters
Parameter	Location, type and description
`q`	query; optional `string; min length 1; max length 100` Free text, 1-100 characters.
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).
`breed`	query; optional `string; min length 1; max length 100` Breed id (<species>.<breed>), a bare breed slug with species, or a name.
`state`	query; optional `string; min length 2; max length 60` US state or Canadian province (code or name).
`source`	query; optional `array<string; one of ["claimed","directory"]>; max items 2` Restrict to these sources.
`updated_since`	query; optional `string; format date-time`
`sync_after`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`sort`	query; optional `string; one of ["claimed_first","name"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.breeder
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-watermark, sync-reset, unknown-filter, ambiguous-filter, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/breeders/{id}`

Get one public breeder

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK breeder.full
301: Moved: this id was replaced by the resource named in Location and moved_to. common.problem
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/providers`

List public service providers in one category

Parameters
Parameter	Location, type and description
`category`	query; optional `string; min length 1; max length 60` Provider category key or name; required.
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).
`state`	query; optional `string; min length 2; max length 60` US state or Canadian province (code or name).
`q`	query; optional `string; min length 1; max length 100` Free text, 1-100 characters.
`source`	query; optional `array<string; one of ["directory","claimed","platform"]>; max items 3` Restrict to these sources.
`updated_since`	query; optional `string; format date-time`
`sync_after`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`sort`	query; optional `string; one of ["default","name"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.provider
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-watermark, sync-reset, unknown-filter, ambiguous-filter, filter-required, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/providers/{id}`

Get one public service provider

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK provider.full
301: Moved: this id was replaced by the resource named in Location and moved_to. common.problem
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/species`

List species

Parameters
Parameter	Location, type and description
`q`	query; optional `string; min length 1; max length 100` Free text, 1-100 characters.
`featured`	query; optional `boolean` true: species the site features.
`has_supply`	query; optional `boolean` true: at least one public active listing or public breeder. Cannot be combined with updated_since or sync_after because supply changes do not stamp species updates.
`updated_since`	query; optional `string; format date-time`
`sync_after`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`sort`	query; optional `string; one of ["featured","title"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.species
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-watermark, sync-reset, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/species/{id}`

Get one species

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK species.full
301: Moved: this id was replaced by the resource named in Location and moved_to. common.problem
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/breeds`

List breeds of a species

Parameters
Parameter	Location, type and description
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).
`q`	query; optional `string; min length 1; max length 100` Free text, 1-100 characters.
`generic`	query; optional `boolean` false: hide generic breeds.
`updated_since`	query; optional `string; format date-time`
`sync_after`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`sort`	query; optional `string; one of ["title","popular"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.breed
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-watermark, sync-reset, unknown-filter, ambiguous-filter, filter-required, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/breeds/{id}`

Get one breed

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK breed.full
301: Moved: this id was replaced by the resource named in Location and moved_to. common.problem
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/articles`

List public articles

Parameters
Parameter	Location, type and description
`source`	query; optional `array<string; one of ["learn","news","species_guide","help_center"]>; max items 4` Restrict to these sources.
`section`	query; optional `string; pattern ^[a-z0-9][a-z0-9-]{0,59}$` Section slug.
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).
`breed`	query; optional `string; min length 1; max length 100` Breed id (<species>.<breed>), a bare breed slug with species, or a name.
`q`	query; optional `string; min length 1; max length 100` Free text, 1-100 characters.
`updated_since`	query; optional `string; format date-time`
`sync_after`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`sort`	query; optional `string; one of ["updated","published"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.article
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-watermark, sync-reset, unknown-filter, ambiguous-filter, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/articles/{id}`

Get one public article

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK article.full
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/tools`

List public tools

Parameters
Parameter	Location, type and description
`tool_type`	query; optional `string; one of ["name_generator","org_name_generator","gestation_calculator","weight_calculator","coat_color_calculator","coat_color_visualizer","livestock_value_calculator","pedigree_chart_maker","brand_generator","brand_ideas","brand_registration","genetics_calculator"]`
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).
`q`	query; optional `string; min length 1; max length 100` Free text, 1-100 characters.
`sort`	query; optional `string; one of ["title"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.tool
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, unknown-filter, ambiguous-filter, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/tools/{id}`

Get one public tool

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK tool.full
301: Moved: this id was replaced by the resource named in Location and moved_to. common.problem
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/sale-events`

List public sale events

Parameters
Parameter	Location, type and description
`phase`	query; optional `string; one of ["upcoming","live","ended"]` Clock-derived event phase. Cannot be combined with updated_since or sync_after because phase changes do not update the sync stamp.
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).
`sale_type`	query; optional `string; one of ["auction","fixed_price"]`
`updated_since`	query; optional `string; format date-time`
`sync_after`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`sort`	query; optional `string; one of ["site"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.sale_event
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-watermark, sync-reset, unknown-filter, ambiguous-filter, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/sale-events/{id}`

Get one public sale event

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK sale_event.full
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/platform-facts`

List platform facts

Parameters
Parameter	Location, type and description
`sort`	query; optional `string; one of ["topic"]`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK envelope.list.platform_fact
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor, invalid-include.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/platform-facts/{id}`

Get one platform fact

Parameters
Parameter	Location, type and description
`id`	path; required `string; pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$` The resource id. Opaque: never parse it.
`include`	query; optional `array<string; pattern ^[a-z_]{1,40}$>; max items 3`

200: OK platform_fact.full
301: Moved: this id was replaced by the resource named in Location and moved_to. common.problem
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-include.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/search`

Search public records across kinds

Parameters
Parameter	Location, type and description
`q`	query; required `string; min length 1; max length 100` Free text, 1-100 characters.
`kinds`	query; optional `array<string; one of ["listing","animal","breeder","provider","species","breed","article","tool","sale_event","platform_fact"]>; max items 10`
`limit`	query; optional `integer; min 1; max 50`
`cursor`	query; optional `string; pattern ^[A-Za-z0-9_-]{16,2048}$`

200: OK envelope.search
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, invalid-cursor.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable, search-unavailable.

GET `/api/v1/lookup`

Turn a creatures.com page URL into a kind and id

Parameters
Parameter	Location, type and description
`url`	query; required `string; min length 8; max length 2048`

200: OK common.lookup_result
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter.
401: Problem codes: invalid-token.
404: Problem codes: not-found.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/resolve`

Resolve a species, breed or category name

Parameters
Parameter	Location, type and description
`q`	query; required `string; min length 1; max length 100` Free text, 1-100 characters.
`kinds`	query; optional `array<string; one of ["species","breed","category"]>; max items 3`
`species`	query; optional `string; min length 1; max length 100` Species id or name (a name is resolved; programmatic clients send ids).

200: OK common.resolve_result
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter, unknown-filter, ambiguous-filter.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

GET `/api/v1/openapi.json`

This OpenAPI document

No parameters.

200: OK object
304: Not modified: If-None-Match matched the ETag.
400: Problem codes: invalid-parameter, unknown-parameter.
401: Problem codes: invalid-token.
405: Problem codes: method-not-allowed.
429: Problem codes: rate-limited.
500: Problem codes: internal.
503: Problem codes: unavailable.

Resource kinds

These tables describe each full resource view. Dotted field names show nested objects; [] shows array items. Named schema references are expanded one level. Deeper references are shown by their OpenAPI component name.

Listing
Animal
Breeder
Provider
Species
Breed
Article
Tool
Sale event
Platform fact

Listing `listing.full`

Listing fields
Field	Type and description
`kind` Kind	`string; value "listing"`
`id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`title` Title	`string; max length 200` The animal's display name.
`url` Page	`string; format uri`
`updated_at` Updated	`string; format date-time`
`status` Status code	`string \| null` Public status, never the stored one: scheduled = auction start in the future; ending = past its close time, awaiting the close job; sale_pending = reserved or in payment. Known values: active, scheduled, ending, sale_pending, auction_won, sold, reserve_not_met, ended_no_bids, cancelled, paused. Clients must accept values not listed.
`status_label` Status	`string \| null`
`sale_type` Sale type	`string \| null` Known values: fixed_price, auction. Clients must accept values not listed.
`price` Price	`common.money \| null` Fixed price; for an auction the current bid, else the starting bid; for a sold listing the sale amount.
`price.amount` Amount	`integer`
`price.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`price.display` Display	`string`
`buy_now_price` Buy now price	`common.money \| null` Set only while buy now is available (active, no bids).
`buy_now_price.amount` Amount	`integer`
`buy_now_price.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`buy_now_price.display` Display	`string`
`bid_count` Bids	`integer \| null` Auctions only.
`starts_at` Auction starts	`string \| null; format date-time`
`ends_at` Auction ends	`string \| null; format date-time`
`species` Species	`common.ref \| null`
`species.kind` Kind	`string`
`species.id` Id	`string`
`species.title` Title	`string`
`species.url` Url	`string \| null; format uri`
`breed` Breed	`common.ref \| null` Null for the placeholder breed.
`breed.kind` Kind	`string`
`breed.id` Id	`string`
`breed.title` Title	`string`
`breed.url` Url	`string \| null; format uri`
`genetics_label` Reported genetics	`string \| null`
`breed_makeup_label` Breed makeup	`string \| null`
`sex` Sex code	`string \| null` Raw sex; filter on this, never on sex_label. Known values: male, female, unknown. Clients must accept values not listed.
`sex_label` Sex	`string \| null` The page's species word, for example Doe or Wether.
`age_label` Age	`string \| null`
`registries` Registries	`array<string>; max items 5` Labels of public registrations only.
`registries_truncated` Registries truncated	`boolean \| null`
`location` Location	`common.location \| null`
`location.city` City	`string \| null`
`location.region` Region	`string \| null`
`location.region_name` Region name	`string \| null`
`location.country` Country	`string \| null`
`seller` Seller	`common.seller_ref \| null` identity_verified is null in the summary and set in the full view.
`seller.kind` Kind	`string` Known values: user, org. Clients must accept values not listed.
`seller.id` Id	`string`
`seller.title` Title	`string`
`seller.url` Url	`string; format uri`
`seller.avatar` Avatar	`common.avatar \| null`
`seller.rating` Rating	`common.rating \| null`
`seller.identity_verified` Identity verified	`boolean \| null`
`image` Image	`common.image \| null`
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`no_buyer_fee` No buyer fee	`boolean \| null`
`sale_event` Sale event	`common.ref \| sale_event.summary \| null` Null unless the event is public; include=sale_event gives its summary.
`sale_event.kind` Kind	`string`
`sale_event.id` Id	`string`
`sale_event.title` Title	`string`
`sale_event.url` Url	`string \| null; format uri`
`sale_event.kind` Kind	`string; value "sale_event"`
`sale_event.id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`sale_event.title` Title	`string; max length 200`
`sale_event.url` Page	`string; format uri`
`sale_event.updated_at` Updated	`string; format date-time`
`sale_event.phase` Phase	`string \| null` From the start and close times, as the event page shows it; never the stored status. Known values: upcoming, live, ended. Clients must accept values not listed.
`sale_event.sale_type` Sale type	`string \| null` fixed_price for events of the stored standard type, which accept fixed-price listings. Known values: auction, fixed_price. Clients must accept values not listed.
`sale_event.starts_at` Starts	`string \| null; format date-time`
`sale_event.ends_at` Ends	`string \| null; format date-time`
`sale_event.species` Species	`array<common.ref>; max items 10` Empty means the event accepts every species.
`sale_event.species_truncated` Species truncated	`boolean \| null`
`sale_event.organizer` Organizer	`common.actor_ref \| null`
`sale_event.summary` Summary	`string \| null; max length 300` The teaser, else the description, as plain text.
`sale_event.summary_truncated` Summary truncated	`boolean \| null`
`sale_event.image` Image	`common.image \| null`
`sale_event.active_lot_count` Active lots	`integer \| null; min 0` The number of listings /api/v1/listings?event=<id> returns; it can be lower than the count on the events page.
`description` Description	`string \| null; max length 4000` The seller's text with Markdown and HTML shown literally; internal links only; mentions of public accounts as their names (A2.6).
`description_truncated` Description truncated	`boolean \| null`
`media` Media	`array<common.media_item>; max items 12`
`media_truncated` Media truncated	`boolean \| null` True when the listing has more than 12 public media files (C5.1 capped list).
`animal` Animal	`common.ref \| animal.summary \| null` Null unless the animal is public; include=animal gives its summary.
`animal.kind` Kind	`string`
`animal.id` Id	`string`
`animal.title` Title	`string`
`animal.url` Url	`string \| null; format uri`
`animal.kind` Kind	`string; value "animal"`
`animal.id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`animal.title` Name	`string; max length 200`
`animal.url` Page	`string; format uri`
`animal.updated_at` Updated	`string; format date-time`
`animal.profile_type` Profile type	`string \| null` owned: a profile someone keeps; reference: added to document lineage and not claimed yet; awaiting_claim: sold and waiting for its new owner to claim it. Known values: owned, reference, awaiting_claim. Clients must accept values not listed.
`animal.species` Species	`common.ref \| null`
`animal.breed` Breed	`common.ref \| null`
`animal.genetics_label` Reported genetics	`string \| null`
`animal.genetics` Reported genetic states	`array<common.genetic_state>; max items 512` Member assertions, without linked-record identifiers or metadata.
`animal.breed_makeup_label` Breed makeup	`string \| null` The makeup label the animal cards print, for example 1/2 Nubian, 1/2 Boer.
`animal.sex` Sex	`string \| null` The raw enum; filter on this, never on sex_label. Known values: male, female, unknown. Clients must accept values not listed.
`animal.sex_label` Sex	`string \| null` The page's species word, for example Doe or Wether.
`animal.birth` Born	`common.partial_date \| null`
`animal.age_label` Age	`string \| null`
`animal.deceased` Deceased	`boolean \| null`
`animal.registered_name` Registered name	`string \| null` From public registry records only (the herdbook rule); never a name whose source record is private.
`animal.location` Location	`common.location \| null` The animal's own location only.
`animal.image` Photo	`common.image \| null`
`animal.listing` For sale	`common.ref \| listing.summary \| null` The animal's active public listing, or null. include=listing replaces the ref with the listing summary.
`color_label` Color	`string \| null`
`birth` Born	`common.partial_date \| null`
`birth.date` Date	`string; pattern ^\d{4}(-\d{2}(-\d{2})?)?$`
`birth.precision` Precision	`string` Known values: year, month, day. Clients must accept values not listed.
`sterilized` Sterilized	`boolean \| null`
`parents` Parents	`object \| null`
`parents.sire` Sire	`common.ref \| null`
`parents.sire.kind` Kind	`string`
`parents.sire.id` Id	`string`
`parents.sire.title` Title	`string`
`parents.sire.url` Url	`string \| null; format uri`
`parents.dam` Dam	`common.ref \| null`
`parents.dam.kind` Kind	`string`
`parents.dam.id` Id	`string`
`parents.dam.title` Title	`string`
`parents.dam.url` Url	`string \| null; format uri`
`auction` Auction	`object \| null` Auctions only. Money in integer cents (A2.4): min_next_bid = (current bid, else starting bid) + increment.
`auction.starting_bid` Starting bid	`common.money \| null`
`auction.starting_bid.amount` Amount	`integer`
`auction.starting_bid.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`auction.starting_bid.display` Display	`string`
`auction.current_bid` Current bid	`common.money \| null`
`auction.current_bid.amount` Amount	`integer`
`auction.current_bid.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`auction.current_bid.display` Display	`string`
`auction.bid_count` Bids	`integer \| null`
`auction.min_next_bid` Minimum next bid	`common.money \| null`
`auction.min_next_bid.amount` Amount	`integer`
`auction.min_next_bid.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`auction.min_next_bid.display` Display	`string`
`auction.increment` Bid increment	`common.money \| null`
`auction.increment.amount` Amount	`integer`
`auction.increment.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`auction.increment.display` Display	`string`
`auction.reserve` Reserve	`object \| null`
`auction.reserve.has_reserve` Has a reserve	`boolean \| null`
`auction.reserve.met` Reserve met	`boolean \| null`
`auction.buy_now_price` Buy now price	`common.money \| null`
`auction.buy_now_price.amount` Amount	`integer`
`auction.buy_now_price.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`auction.buy_now_price.display` Display	`string`
`auction.starts_at` Starts	`string \| null; format date-time`
`auction.ends_at` Ends	`string \| null; format date-time`
`auction.soft_close` Soft close	`object \| null`
`auction.soft_close.trigger_window_seconds` Trigger window (seconds)	`integer \| null`
`auction.soft_close.extension_seconds` Extension (seconds)	`integer \| null`
`fulfillment` Fulfillment	`object \| null`
`fulfillment.pickup` Pickup	`boolean \| null`
`fulfillment.delivery` Seller delivery	`object \| null`
`fulfillment.delivery.base` Base rate	`common.money \| null`
`fulfillment.delivery.base.amount` Amount	`integer`
`fulfillment.delivery.base.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`fulfillment.delivery.base.display` Display	`string`
`fulfillment.delivery.per_mile` Per mile	`common.money \| null`
`fulfillment.delivery.per_mile.amount` Amount	`integer`
`fulfillment.delivery.per_mile.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`fulfillment.delivery.per_mile.display` Display	`string`
`fulfillment.delivery.max_miles` Maximum miles	`integer \| null`
`fulfillment.transport_quote_available` Transport quote available	`boolean \| null`
`boarding` Boarding	`object \| null`
`boarding.required` Boarding required	`boolean \| null`
`boarding.monthly_total` Monthly total	`common.money \| null`
`boarding.monthly_total.amount` Amount	`integer`
`boarding.monthly_total.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`boarding.monthly_total.display` Display	`string`
`boarding.min_months` Minimum months	`integer \| null`
`boarding.included_months` Included months	`integer \| null`
`requires_buyer_approval` Buyer approval required	`boolean \| null`
`accepts_offers` Accepts offers	`boolean \| null`
`availability_confirmed` Availability confirmed	`boolean \| null` False when the seller has not recently confirmed an active listing is still available; null when not active.
`sold` Sale	`object \| null`
`sold.sold_at` Sold	`string \| null; format date-time`
`sold.sale_amount` Sale amount	`common.money \| null`
`sold.sale_amount.amount` Amount	`integer`
`sold.sale_amount.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`sold.sale_amount.display` Display	`string`
`sold.purchase_type` Purchase type	`string \| null` Known values: fixed_price, offer, buy_now, auction. Clients must accept values not listed.

Animal `animal.full`

Animal fields
Field	Type and description
`kind` Kind	`string; value "animal"`
`id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`title` Name	`string; max length 200`
`url` Page	`string; format uri`
`updated_at` Updated	`string; format date-time`
`profile_type` Profile type	`string \| null` owned: a profile someone keeps; reference: added to document lineage and not claimed yet; awaiting_claim: sold and waiting for its new owner to claim it. Known values: owned, reference, awaiting_claim. Clients must accept values not listed.
`species` Species	`common.ref \| null`
`species.kind` Kind	`string`
`species.id` Id	`string`
`species.title` Title	`string`
`species.url` Url	`string \| null; format uri`
`breed` Breed	`common.ref \| null`
`breed.kind` Kind	`string`
`breed.id` Id	`string`
`breed.title` Title	`string`
`breed.url` Url	`string \| null; format uri`
`genetics_label` Reported genetics	`string \| null`
`genetics` Reported genetic states	`array<common.genetic_state>; max items 512` Member assertions, without linked-record identifiers or metadata.
`genetics[].definition` Definition	`common.ref \| null`
`genetics[].name` Name	`string`
`genetics[].kind` Kind	`string` Known values: gene, phenotype, trait. Clients must accept values not listed.
`genetics[].state` State	`string` Known values: homozygous, heterozygous, hemizygous, present, possible, absent, unresolved. Clients must accept values not listed.
`genetics[].label` Label	`string`
`genetics[].evidence` Evidence	`string` Known values: visual, owner_reported, breeding_proven, dna_tested, pedigree_derived, registry_imported. Clients must accept values not listed.
`genetics[].evidence_label` Evidence label	`string`
`genetics[].backed_by_record` Backed by record	`boolean`
`genetics[].reported_probability` Reported probability	`string \| null` The member's reported percentage, never a computed prediction.
`genetics[].probability_basis` Probability basis	`string \| null` Known values: pedigree_odds, breeder_paperwork, custom. Clients must accept values not listed.
`genetics[].status` Status	`string` Known values: current, disputed. Clients must accept values not listed.
`genetics[].original_wording` Original wording	`string \| null; max length 4000`
`genetics[].source_reference` Source reference	`string \| null; max length 4000`
`genetics[].reported_at` Reported at	`string \| null; format date`
`genetics[].test_scope` Test scope	`string \| null; max length 4000`
`genetics[].note` Note	`string \| null; max length 4000`
`genetics[].risks` Risks	`array<object>`
`genetics[].risks[].certainty` Certainty	`string` Known values: deterministic, reported, unknown. Clients must accept values not listed.
`genetics[].risks[].effect` Effect	`string` Known values: nonviable, health, fertility, unknown. Clients must accept values not listed.
`genetics[].risks[].description` Description	`string`
`breed_makeup_label` Breed makeup	`string \| null` The makeup label the animal cards print, for example 1/2 Nubian, 1/2 Boer.
`sex` Sex	`string \| null` The raw enum; filter on this, never on sex_label. Known values: male, female, unknown. Clients must accept values not listed.
`sex_label` Sex	`string \| null` The page's species word, for example Doe or Wether.
`birth` Born	`common.partial_date \| null`
`birth.date` Date	`string; pattern ^\d{4}(-\d{2}(-\d{2})?)?$`
`birth.precision` Precision	`string` Known values: year, month, day. Clients must accept values not listed.
`age_label` Age	`string \| null`
`deceased` Deceased	`boolean \| null`
`registered_name` Registered name	`string \| null` From public registry records only (the herdbook rule); never a name whose source record is private.
`location` Location	`common.location \| null` The animal's own location only.
`location.city` City	`string \| null`
`location.region` Region	`string \| null`
`location.region_name` Region name	`string \| null`
`location.country` Country	`string \| null`
`image` Photo	`common.image \| null`
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`listing` For sale	`common.ref \| listing.summary \| null` The animal's active public listing, or null. include=listing replaces the ref with the listing summary.
`listing.kind` Kind	`string`
`listing.id` Id	`string`
`listing.title` Title	`string`
`listing.url` Url	`string \| null; format uri`
`listing.kind` Kind	`string; value "listing"`
`listing.id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`listing.title` Title	`string; max length 200` The animal's display name.
`listing.url` Page	`string; format uri`
`listing.updated_at` Updated	`string; format date-time`
`listing.status` Status code	`string \| null` Public status, never the stored one: scheduled = auction start in the future; ending = past its close time, awaiting the close job; sale_pending = reserved or in payment. Known values: active, scheduled, ending, sale_pending, auction_won, sold, reserve_not_met, ended_no_bids, cancelled, paused. Clients must accept values not listed.
`listing.status_label` Status	`string \| null`
`listing.sale_type` Sale type	`string \| null` Known values: fixed_price, auction. Clients must accept values not listed.
`listing.price` Price	`common.money \| null` Fixed price; for an auction the current bid, else the starting bid; for a sold listing the sale amount.
`listing.buy_now_price` Buy now price	`common.money \| null` Set only while buy now is available (active, no bids).
`listing.bid_count` Bids	`integer \| null` Auctions only.
`listing.starts_at` Auction starts	`string \| null; format date-time`
`listing.ends_at` Auction ends	`string \| null; format date-time`
`listing.species` Species	`common.ref \| null`
`listing.breed` Breed	`common.ref \| null` Null for the placeholder breed.
`listing.genetics_label` Reported genetics	`string \| null`
`listing.breed_makeup_label` Breed makeup	`string \| null`
`listing.sex` Sex code	`string \| null` Raw sex; filter on this, never on sex_label. Known values: male, female, unknown. Clients must accept values not listed.
`listing.sex_label` Sex	`string \| null` The page's species word, for example Doe or Wether.
`listing.age_label` Age	`string \| null`
`listing.registries` Registries	`array<string>; max items 5` Labels of public registrations only.
`listing.registries_truncated` Registries truncated	`boolean \| null`
`listing.location` Location	`common.location \| null`
`listing.seller` Seller	`common.seller_ref \| null` identity_verified is null in the summary and set in the full view.
`listing.image` Image	`common.image \| null`
`listing.no_buyer_fee` No buyer fee	`boolean \| null`
`listing.sale_event` Sale event	`common.ref \| sale_event.summary \| null` Null unless the event is public; include=sale_event gives its summary.
`about` About	`string \| null; max length 4000` The owner's text with Markdown and HTML syntax escaped (A2.6).
`about_truncated` About truncated	`boolean \| null`
`color_label` Color	`string \| null`
`sterilized_label` Sterilized	`string \| null` Spayed, Neutered or Sterilized as the page shows it; null when not sterilized or already implied by the sex word.
`death` Died	`object \| null`
`death.date` Date	`common.partial_date \| null`
`death.date.date` Date	`string; pattern ^\d{4}(-\d{2}(-\d{2})?)?$`
`death.date.precision` Precision	`string` Known values: year, month, day. Clients must accept values not listed.
`death.label` Label	`string \| null`
`owners` Owners	`array<common.actor_ref>; max items 20` Owner and co-owner actors in good standing, org first; team, boarding-provider and previous-owner (custodian) rows are never listed.
`owners[].kind` Kind	`string` Known values: user, org. Clients must accept values not listed.
`owners[].id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`owners[].title` Title	`string`
`owners[].url` Url	`string; format uri`
`owners[].avatar` Avatar	`common.avatar \| null`
`owners_truncated` Owners truncated	`boolean \| null`
`parents` Parents	`object \| null` Sire and dam when each is public; include=parents replaces each ref with its summary.
`parents.sire` Sire	`common.ref \| animal.summary \| null`
`parents.sire.kind` Kind	`string`
`parents.sire.id` Id	`string`
`parents.sire.title` Title	`string`
`parents.sire.url` Url	`string \| null; format uri`
`parents.sire.kind` Kind	`string; value "animal"`
`parents.sire.id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`parents.sire.title` Name	`string; max length 200`
`parents.sire.url` Page	`string; format uri`
`parents.sire.updated_at` Updated	`string; format date-time`
`parents.sire.profile_type` Profile type	`string \| null` owned: a profile someone keeps; reference: added to document lineage and not claimed yet; awaiting_claim: sold and waiting for its new owner to claim it. Known values: owned, reference, awaiting_claim. Clients must accept values not listed.
`parents.sire.species` Species	`common.ref \| null`
`parents.sire.breed` Breed	`common.ref \| null`
`parents.sire.genetics_label` Reported genetics	`string \| null`
`parents.sire.genetics` Reported genetic states	`array<common.genetic_state>; max items 512` Member assertions, without linked-record identifiers or metadata.
`parents.sire.breed_makeup_label` Breed makeup	`string \| null` The makeup label the animal cards print, for example 1/2 Nubian, 1/2 Boer.
`parents.sire.sex` Sex	`string \| null` The raw enum; filter on this, never on sex_label. Known values: male, female, unknown. Clients must accept values not listed.
`parents.sire.sex_label` Sex	`string \| null` The page's species word, for example Doe or Wether.
`parents.sire.birth` Born	`common.partial_date \| null`
`parents.sire.age_label` Age	`string \| null`
`parents.sire.deceased` Deceased	`boolean \| null`
`parents.sire.registered_name` Registered name	`string \| null` From public registry records only (the herdbook rule); never a name whose source record is private.
`parents.sire.location` Location	`common.location \| null` The animal's own location only.
`parents.sire.image` Photo	`common.image \| null`
`parents.sire.listing` For sale	`common.ref \| listing.summary \| null` The animal's active public listing, or null. include=listing replaces the ref with the listing summary.
`parents.dam` Dam	`common.ref \| animal.summary \| null`
`parents.dam.kind` Kind	`string`
`parents.dam.id` Id	`string`
`parents.dam.title` Title	`string`
`parents.dam.url` Url	`string \| null; format uri`
`parents.dam.kind` Kind	`string; value "animal"`
`parents.dam.id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`parents.dam.title` Name	`string; max length 200`
`parents.dam.url` Page	`string; format uri`
`parents.dam.updated_at` Updated	`string; format date-time`
`parents.dam.profile_type` Profile type	`string \| null` owned: a profile someone keeps; reference: added to document lineage and not claimed yet; awaiting_claim: sold and waiting for its new owner to claim it. Known values: owned, reference, awaiting_claim. Clients must accept values not listed.
`parents.dam.species` Species	`common.ref \| null`
`parents.dam.breed` Breed	`common.ref \| null`
`parents.dam.genetics_label` Reported genetics	`string \| null`
`parents.dam.genetics` Reported genetic states	`array<common.genetic_state>; max items 512` Member assertions, without linked-record identifiers or metadata.
`parents.dam.breed_makeup_label` Breed makeup	`string \| null` The makeup label the animal cards print, for example 1/2 Nubian, 1/2 Boer.
`parents.dam.sex` Sex	`string \| null` The raw enum; filter on this, never on sex_label. Known values: male, female, unknown. Clients must accept values not listed.
`parents.dam.sex_label` Sex	`string \| null` The page's species word, for example Doe or Wether.
`parents.dam.birth` Born	`common.partial_date \| null`
`parents.dam.age_label` Age	`string \| null`
`parents.dam.deceased` Deceased	`boolean \| null`
`parents.dam.registered_name` Registered name	`string \| null` From public registry records only (the herdbook rule); never a name whose source record is private.
`parents.dam.location` Location	`common.location \| null` The animal's own location only.
`parents.dam.image` Photo	`common.image \| null`
`parents.dam.listing` For sale	`common.ref \| listing.summary \| null` The animal's active public listing, or null. include=listing replaces the ref with the listing summary.
`media` Media	`array<common.media_item>; max items 12`
`media_truncated` Media truncated	`boolean \| null`

Breeder `breeder.full`

Breeder fields
Field	Type and description
`kind` Kind	`string; value "breeder"`
`id` Id	`string; pattern ^(org\|dir)_[0-9A-Za-z]{8}$`
`title` Name	`string; max length 200`
`url` Page	`string; format uri`
`updated_at` Updated	`string; format date-time`
`source` Source	`string \| null` claimed: a breeder org on Creatures; directory: an imported directory entry its business has not claimed. Known values: claimed, directory. Clients must accept values not listed.
`verified` Identity verified	`boolean \| null` The org's identity-verified flag; always false for directory entries.
`location` Location	`common.location \| null`
`location.city` City	`string \| null`
`location.region` Region	`string \| null`
`location.region_name` Region name	`string \| null`
`location.country` Country	`string \| null`
`species` Species	`array<common.ref>; max items 20`
`species[].kind` Kind	`string`
`species[].id` Id	`string`
`species[].title` Title	`string`
`species[].url` Url	`string \| null; format uri`
`species_truncated` Species truncated	`boolean \| null`
`breeds` Breeds	`array<common.ref>; max items 50`
`breeds[].kind` Kind	`string`
`breeds[].id` Id	`string`
`breeds[].title` Title	`string`
`breeds[].url` Url	`string \| null; format uri`
`breeds_truncated` Breeds truncated	`boolean \| null`
`image` Image	`common.image \| null` The org picture; null for directory entries.
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`summary` Summary	`string \| null; max length 300` Plain text from the org's about or the entry's description.
`summary_truncated` Summary truncated	`boolean \| null`
`description` Description	`string \| null; max length 4000` User text (A2.6), shown literally.
`description_truncated` Description truncated	`boolean \| null`
`website` Website	`string \| null; format uri`
`socials` Social links	`array<object>; max items 6` Known networks only, one link per network.
`socials[].network` Network	`string` Known values: facebook, instagram, tiktok, youtube, x, linkedin. Clients must accept values not listed.
`socials[].url` Link	`string; format uri`
`claimable` Claimable	`boolean \| null` True for directory entries (the business can claim the listing); null for claimed orgs.
`type_label` Type	`string \| null` The org type label (Breeder, Farm, Ranch); null for directory entries.
`rating` Rating	`common.rating \| null` Claimed orgs: reviews of the org and its members (scope org_and_members), as on the org page; null for directory entries.
`rating.average` Average	`number \| null`
`rating.count` Count	`integer \| null`
`rating.scope` Scope	`string` Known values: seller, org_and_members, owner_and_owned_orgs, provider. Clients must accept values not listed.
`active_listing_count` Active listings	`integer \| null` Public active listings the org sells (the /listings?seller=org_<id> population); null for directory entries.
`listings` Listings	`null \| object` Up to five of the org's active listings (org sellers only); null unless include=listings, and always null for directory entries.
`listings.data` Listings	`array<listing.summary>; max items 5`
`listings.data[].kind` Kind	`string; value "listing"`
`listings.data[].id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`listings.data[].title` Title	`string; max length 200` The animal's display name.
`listings.data[].url` Page	`string; format uri`
`listings.data[].updated_at` Updated	`string; format date-time`
`listings.data[].status` Status code	`string \| null` Public status, never the stored one: scheduled = auction start in the future; ending = past its close time, awaiting the close job; sale_pending = reserved or in payment. Known values: active, scheduled, ending, sale_pending, auction_won, sold, reserve_not_met, ended_no_bids, cancelled, paused. Clients must accept values not listed.
`listings.data[].status_label` Status	`string \| null`
`listings.data[].sale_type` Sale type	`string \| null` Known values: fixed_price, auction. Clients must accept values not listed.
`listings.data[].price` Price	`common.money \| null` Fixed price; for an auction the current bid, else the starting bid; for a sold listing the sale amount.
`listings.data[].buy_now_price` Buy now price	`common.money \| null` Set only while buy now is available (active, no bids).
`listings.data[].bid_count` Bids	`integer \| null` Auctions only.
`listings.data[].starts_at` Auction starts	`string \| null; format date-time`
`listings.data[].ends_at` Auction ends	`string \| null; format date-time`
`listings.data[].species` Species	`common.ref \| null`
`listings.data[].breed` Breed	`common.ref \| null` Null for the placeholder breed.
`listings.data[].genetics_label` Reported genetics	`string \| null`
`listings.data[].breed_makeup_label` Breed makeup	`string \| null`
`listings.data[].sex` Sex code	`string \| null` Raw sex; filter on this, never on sex_label. Known values: male, female, unknown. Clients must accept values not listed.
`listings.data[].sex_label` Sex	`string \| null` The page's species word, for example Doe or Wether.
`listings.data[].age_label` Age	`string \| null`
`listings.data[].registries` Registries	`array<string>; max items 5` Labels of public registrations only.
`listings.data[].registries_truncated` Registries truncated	`boolean \| null`
`listings.data[].location` Location	`common.location \| null`
`listings.data[].seller` Seller	`common.seller_ref \| null` identity_verified is null in the summary and set in the full view.
`listings.data[].image` Image	`common.image \| null`
`listings.data[].no_buyer_fee` No buyer fee	`boolean \| null`
`listings.data[].sale_event` Sale event	`common.ref \| sale_event.summary \| null` Null unless the event is public; include=sale_event gives its summary.
`listings.has_more` More listings	`boolean`
`listings.list_url` All listings	`string; format uri`

Provider `provider.full`

Provider fields
Field	Type and description
`kind` Kind	`string; value "provider"`
`id` Id	`string; pattern ^(dir\|org\|tr\|bd\|ss)_[0-9A-Za-z]{8}$`
`title` Name	`string; max length 200`
`url` Page	`string; format uri`
`updated_at` Updated	`string; format date-time`
`source` Source	`string \| null` directory: an imported directory record that Creatures does not rank or endorse; claimed: a business that claimed its directory record; platform: a Creatures-reviewed platform transporter, a boarding service or a current public stud offer. Known values: directory, claimed, platform. Clients must accept values not listed.
`categories` Categories	`array<object>; max items 7`
`categories[].key` Key	`string`
`categories[].label` Label	`string`
`summary` Summary	`string \| null; max length 300`
`summary_truncated` Summary truncated	`boolean \| null`
`location` Location	`common.location \| null`
`location.city` City	`string \| null`
`location.region` Region	`string \| null`
`location.region_name` Region name	`string \| null`
`location.country` Country	`string \| null`
`species` Species	`array<common.ref>; max items 50`
`species[].kind` Kind	`string`
`species[].id` Id	`string`
`species[].title` Title	`string`
`species[].url` Url	`string \| null; format uri`
`species_truncated` Species truncated	`boolean \| null`
`species_count` Species count	`integer \| null`
`services` Services	`array<string>; max items 50`
`services_truncated` Services truncated	`boolean \| null`
`claimed` Claimed	`boolean \| null`
`verified` Verified	`boolean \| null`
`rating` Rating	`common.rating \| null`
`rating.average` Average	`number \| null`
`rating.count` Count	`integer \| null`
`rating.scope` Scope	`string` Known values: seller, org_and_members, owner_and_owned_orgs, provider. Clients must accept values not listed.
`rate` Rate	`common.rate \| null`
`rate.amount` Amount	`integer`
`rate.currency` Currency	`string` Known values: USD, AED, AFN, ALL, AMD, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XCG, XOF, XPF, YER, ZAR, ZMW, ZWG. Clients must accept values not listed.
`rate.display` Display	`string`
`rate.unit` Unit	`string` Known values: per_animal_month, per_service. Clients must accept values not listed.
`image` Image	`common.image \| null`
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`description` Description	`string \| null; max length 4000`
`description_truncated` Description truncated	`boolean \| null`
`website` Website	`string \| null; format uri` Directory records only.
`licenses` Licences	`array<string>; max items 20` Directory records: licence and registration labels only, never numbers.
`licenses_truncated` Licences truncated	`boolean \| null`
`operating_status` Operating status	`string \| null`
`status_checked_at` Status checked	`string \| null; format date-time`
`travels` Travels	`string \| null`
`service_area_text` Service area	`string \| null`
`service_area` Service area	`null \| object` Platform transporters only.
`service_area.regions` Regions	`array<string>; max items 70` continental_us, then any extra state codes; otherwise the state codes.
`service_area.regions_truncated` Regions truncated	`boolean \| null`
`service_area.radius_mi` Radius (miles)	`integer \| null`
`credentials` Credentials	`null \| object` Platform transporters only. Flags, never filters.
`credentials.identity_verified` Identity verified	`boolean`
`credentials.licensed` Licensed	`boolean` A licence file is on record and Creatures reviewed it.
`credentials.insured_through` Insured through	`string \| null; format date` The insurance date, only while the insurance is current and reviewed.
`rates` Rates	`null \| object` Platform transporters only.
`rates.per_mile` Per mile	`common.money \| null`
`rates.per_mile.amount` Amount	`integer`
`rates.per_mile.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`rates.per_mile.display` Display	`string`
`rates.minimum` Minimum	`common.money \| null`
`rates.minimum.amount` Amount	`integer`
`rates.minimum.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`rates.minimum.display` Display	`string`
`vehicle_types` Vehicle types	`array<string>; max items 20`
`vehicle_types_truncated` Vehicle types truncated	`boolean \| null`
`capacity` Capacity	`string \| null`
`completed_jobs` Completed jobs	`integer \| null`
`owner` Owner	`common.actor_ref \| null` Platform transporters only.
`owner.kind` Kind	`string` Known values: user, org. Clients must accept values not listed.
`owner.id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`owner.title` Title	`string`
`owner.url` Url	`string; format uri`
`owner.avatar` Avatar	`common.avatar \| null`
`terms` Terms	`string \| null; max length 4000` Boarding only.
`terms_truncated` Terms truncated	`boolean \| null`
`housing_type` Housing type	`string \| null`
`housing_type_label` Housing	`string \| null`
`min_commitment_months` Minimum commitment (months)	`integer \| null`
`customer_fee` Service fee	`common.money \| null` Boarding: the monthly service fee added to the rate.
`customer_fee.amount` Amount	`integer`
`customer_fee.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`customer_fee.display` Display	`string`
`provider` Provider	`common.actor_ref \| null` Boarding only.
`provider.kind` Kind	`string` Known values: user, org. Clients must accept values not listed.
`provider.id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`provider.title` Title	`string`
`provider.url` Url	`string; format uri`
`provider.avatar` Avatar	`common.avatar \| null`
`media` Media	`array<common.media_item>; max items 12`
`media_truncated` Media truncated	`boolean \| null`
`other_services` Other services	`array<common.ref>; max items 3` Boarding: other public services of the same provider.
`other_services[].kind` Kind	`string`
`other_services[].id` Id	`string`
`other_services[].title` Title	`string`
`other_services[].url` Url	`string \| null; format uri`
`other_services_truncated` Other services truncated	`boolean \| null`

Species `species.full`

Species fields
Field	Type and description
`kind` Kind	`string; value "species"`
`id` Id	`string; pattern ^[A-Za-z0-9][A-Za-z0-9_-]{0,79}$` The species slug, for example goat.
`title` Title	`string; max length 200`
`url` Page	`string; format uri`
`updated_at` Updated	`string; format date-time`
`latin_name` Latin name	`string \| null; max length 200`
`image` Image	`common.image \| null`
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`featured` Featured	`boolean \| null` True when the site features the species (its priority is above 0).
`general` General	`boolean \| null` True for umbrella rows such as snake and fish (species::general_rows).
`plural_title` Plural title	`string \| null; max length 200`
`description` Description	`string \| null; max length 4000` Plain text.
`description_truncated` Description truncated	`boolean \| null`
`counts` Counts	`object \| null` The species page's own counts. listings includes reserved and payment-pending listings, as the page does; animals counts public profiles without an active listing; breeds counts public population breeds. A hidden record never changes a count.
`counts.listings` Listings	`integer`
`counts.breeders` Breeders	`integer`
`counts.animals` Animals	`integer`
`counts.breeds` Breeds	`integer`
`counts_as_of` Counts as of	`string \| null; format date-time`
`price_range` Price range	`object \| null` Lowest and highest asking price of the listings counted in counts.listings.
`price_range.min` Min	`common.money`
`price_range.min.amount` Amount	`integer`
`price_range.min.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`price_range.min.display` Display	`string`
`price_range.max` Max	`common.money`
`price_range.max.amount` Amount	`integer`
`price_range.max.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`price_range.max.display` Display	`string`
`links` Links	`object \| null`
`links.marketplace_url` For sale	`string \| null; format uri`
`links.directory_url` Breeders	`string \| null; format uri`
`links.price_guide_url` Price guide	`string \| null; format uri`
`featured_breeds` Popular breeds	`array<common.ref>; max items 12` The page's Popular breeds, in page order, that pass the breed gate.
`featured_breeds[].kind` Kind	`string`
`featured_breeds[].id` Id	`string`
`featured_breeds[].title` Title	`string`
`featured_breeds[].url` Url	`string \| null; format uri`
`tools` Tools	`array<common.ref>; max items 12`
`tools[].kind` Kind	`string`
`tools[].id` Id	`string`
`tools[].title` Title	`string`
`tools[].url` Url	`string \| null; format uri`
`articles` Guides	`array<common.ref>; max items 6`
`articles[].kind` Kind	`string`
`articles[].id` Id	`string`
`articles[].title` Title	`string`
`articles[].url` Url	`string \| null; format uri`
`articles_truncated` Guides truncated	`boolean \| null`

Breed `breed.full`

Breed fields
Field	Type and description
`kind` Kind	`string; value "breed"`
`id` Id	`string; max length 80; pattern ^[A-Za-z0-9][A-Za-z0-9_-]\.[A-Za-z0-9][A-Za-z0-9_-]$` <species slug>.<breed slug>, for example goat.nigerian-dwarf.
`title` Title	`string; max length 200`
`url` Page	`string \| null; format uri` Null when the catalog identity is unpublished.
`updated_at` Updated	`string; format date-time`
`species` Species	`common.ref \| species.summary \| null` A species ref, or its summary with include=species.
`species.kind` Kind	`string`
`species.id` Id	`string`
`species.title` Title	`string`
`species.url` Url	`string \| null; format uri`
`species.kind` Kind	`string; value "species"`
`species.id` Id	`string; pattern ^[A-Za-z0-9][A-Za-z0-9_-]{0,79}$` The species slug, for example goat.
`species.title` Title	`string; max length 200`
`species.url` Page	`string; format uri`
`species.updated_at` Updated	`string; format date-time`
`species.latin_name` Latin name	`string \| null; max length 200`
`species.image` Image	`common.image \| null`
`species.featured` Featured	`boolean \| null` True when the site features the species (its priority is above 0).
`species.general` General	`boolean \| null` True for umbrella rows such as snake and fish (species::general_rows).
`image` Image	`common.image \| null`
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`catalog_kind` Catalog kind	`string \| null` Known values: population, gene, phenotype, trait. Clients must accept values not listed.
`publication` Publication	`string \| null` Known values: published, none. Clients must accept values not listed.
`generic` Generic	`boolean \| null` True for generic breeds (mixed, unknown or other).
`description` Description	`string \| null; max length 4000` Plain text.
`description_truncated` Description truncated	`boolean \| null`
`colors` Colors	`array<string>; max items 50`
`colors_truncated` Colors truncated	`boolean \| null`
`counts` Counts	`object \| null` The breed page's own counts. listings includes reserved and payment-pending listings, as the page does; animals counts public profiles without an active listing. A hidden record never changes a count.
`counts.listings` Listings	`integer`
`counts.breeders` Breeders	`integer`
`counts.animals` Animals	`integer`
`counts_as_of` Counts as of	`string \| null; format date-time`
`price_range` Price range	`object \| null` Lowest and highest asking price of the listings counted in counts.listings.
`price_range.min` Min	`common.money`
`price_range.min.amount` Amount	`integer`
`price_range.min.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`price_range.min.display` Display	`string`
`price_range.max` Max	`common.money`
`price_range.max.amount` Amount	`integer`
`price_range.max.currency` Currency	`string` Known values: USD. Clients must accept values not listed.
`price_range.max.display` Display	`string`
`links` Links	`object \| null`
`links.marketplace_url` For sale	`string \| null; format uri`
`links.directory_url` Breeders	`string \| null; format uri`
`links.price_guide_url` Price guide	`string \| null; format uri`
`associations` Breed associations	`array<object>; max items 3`
`associations[].title` Name	`string`
`associations[].url` Page	`string \| null; format uri` Null when the catalog identity is unpublished.
`also_known_as` Also known as	`array<string>; max items 20` Reviewed nicknames (the breed index search terms).
`also_known_as_truncated` Also known as truncated	`boolean \| null`
`related_breeds` Related breeds	`array<common.ref>; max items 12` The page's Popular breeds of this species, without this breed.
`related_breeds[].kind` Kind	`string`
`related_breeds[].id` Id	`string`
`related_breeds[].title` Title	`string`
`related_breeds[].url` Url	`string \| null; format uri`
`tools` Tools	`array<common.ref>; max items 12`
`tools[].kind` Kind	`string`
`tools[].id` Id	`string`
`tools[].title` Title	`string`
`tools[].url` Url	`string \| null; format uri`
`articles` Guides	`array<common.ref>; max items 6`
`articles[].kind` Kind	`string`
`articles[].id` Id	`string`
`articles[].title` Title	`string`
`articles[].url` Url	`string \| null; format uri`
`articles_truncated` Guides truncated	`boolean \| null`

Article `article.full`

Article fields
Field	Type and description
`kind` Kind	`string; value "article"`
`id` Id	`string; pattern ^(wp_[1-9][0-9]{0,8}\|hc_[0-9a-z]{1,40})$`
`title` Title	`string; max length 200`
`url` Page	`string; format uri` The article page on this site; Help Center entries link to help.creatures.com.
`updated_at` Updated	`string; format date-time` When the local copy last changed (the WordPress mirror or the Help Center scrape), not the editorial time.
`published_at` Published	`string \| null; format date-time` WordPress date_gmt; null for Help Center entries.
`modified_at` Modified	`string \| null; format date-time` WordPress modified_gmt; null for Help Center entries.
`source` Source	`string \| null` Known values: learn, news, species_guide, help_center. Clients must accept values not listed.
`section` Section	`object \| null` The Learn section (WordPress category) for learn and news posts; null for species guides and Help Center entries.
`section.slug` Slug	`string`
`section.title` Title	`string`
`species` Species	`common.ref \| null`
`species.kind` Kind	`string`
`species.id` Id	`string`
`species.title` Title	`string`
`species.url` Url	`string \| null; format uri`
`breed` Breed	`common.ref \| null`
`breed.kind` Kind	`string`
`breed.id` Id	`string`
`breed.title` Title	`string`
`breed.url` Url	`string \| null; format uri`
`excerpt` Excerpt	`string \| null; max length 300`
`excerpt_truncated` Excerpt truncated	`boolean \| null`
`image` Image	`common.image \| null` WordPress-hosted article images have large only (A2.7).
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`body` Body	`string \| null; max length 4000` Markdown subset (paragraphs, headings, lists, links, bold, italic) of the page body; links to checkout, bid, offer, payment and sign-in pages are dropped. Null for Help Center entries; the url has the full article (A2.6).
`body_truncated` Body truncated	`boolean \| null`
`author` Author	`object \| null` The byline the article page shows; null when the page shows none.
`author.title` Name	`string`
`author.url` Page	`string \| null; format uri` Known author profile, or null when the source author has no verified local profile.
`related` Related	`array<common.ref>; max items 3` Up to three served articles from the page's own more-articles rail; empty for Help Center entries.
`related[].kind` Kind	`string`
`related[].id` Id	`string`
`related[].title` Title	`string`
`related[].url` Url	`string \| null; format uri`

Tool `tool.full`

Tool fields
Field	Type and description
`kind` Kind	`string; value "tool"`
`id` Id	`string; max length 80; pattern ^[a-z_]+\.[a-z0-9]+(-[a-z0-9]+)*$` <tool_type>.<slug>, for example gestation_calculator.goat.
`title` Title	`string; max length 200`
`url` Page	`string; format uri`
`updated_at` Updated	`string; format date-time`
`tool_type` Tool type	`string \| null` Known values: name_generator, org_name_generator, gestation_calculator, weight_calculator, coat_color_calculator, coat_color_visualizer, livestock_value_calculator, pedigree_chart_maker, brand_generator, brand_ideas, brand_registration, genetics_calculator. Clients must accept values not listed.
`subject` Subject	`object \| null`
`subject.species` Species	`common.ref \| null`
`subject.species.kind` Kind	`string`
`subject.species.id` Id	`string`
`subject.species.title` Title	`string`
`subject.species.url` Url	`string \| null; format uri`
`subject.breed` Breed	`common.ref \| null`
`subject.breed.kind` Kind	`string`
`subject.breed.id` Id	`string`
`subject.breed.title` Title	`string`
`subject.breed.url` Url	`string \| null; format uri`
`subject.org_type` Organization type	`string \| null`
`description` Description	`string \| null; max length 300`
`description_truncated` Description truncated	`boolean \| null`
`image` Image	`common.image \| null`
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`intro` Introduction	`string \| null; max length 4000` Plain text.
`intro_truncated` Introduction truncated	`boolean \| null`
`faq` Questions	`array<object>; max items 5`
`faq[].question` Question	`string; max length 300`
`faq[].question_truncated` Question truncated	`boolean`
`faq[].answer` Answer	`string; max length 4000`
`faq[].answer_truncated` Answer truncated	`boolean`
`faq_truncated` Questions truncated	`boolean \| null`
`gestation` Gestation facts	`object \| null` The gestation calculator page's static facts; null for other tool types.
`gestation.average_days` Average days	`integer`
`gestation.window_days` Window	`object`
`gestation.window_days.min` Min days	`integer`
`gestation.window_days.max` Max days	`integer`
`gestation.birth_event` Birth event	`string \| null`
`gestation.by_breed` By breed	`array<object>; max items 50`
`gestation.by_breed[].key` Key	`string`
`gestation.by_breed[].label` Breed	`string`
`gestation.by_breed[].average_days` Average days	`integer`
`gestation.by_breed[].window_days` Window	`object`
`gestation.by_breed[].window_days.min` Min days	`integer`
`gestation.by_breed[].window_days.max` Max days	`integer`
`gestation.by_breed_truncated` By breed truncated	`boolean`
`weight` Weight facts	`object \| null` The weight calculator page's static facts; null for other tool types.
`weight.typical_range` Typical weights	`array<object>; max items 10`
`weight.typical_range[].class` Class	`string`
`weight.typical_range[].min` Min	`number`
`weight.typical_range[].max` Max	`number`
`weight.typical_range[].unit` Unit	`string`
`weight.measurements` Measurements	`array<object>; max items 10`
`weight.measurements[].key` Key	`string`
`weight.measurements[].label` Measurement	`string`
`weight.measurements[].help` How to measure	`string \| null`

Sale event `sale_event.full`

Sale event fields
Field	Type and description
`kind` Kind	`string; value "sale_event"`
`id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`title` Title	`string; max length 200`
`url` Page	`string; format uri`
`updated_at` Updated	`string; format date-time`
`phase` Phase	`string \| null` From the start and close times, as the event page shows it; never the stored status. Known values: upcoming, live, ended. Clients must accept values not listed.
`sale_type` Sale type	`string \| null` fixed_price for events of the stored standard type, which accept fixed-price listings. Known values: auction, fixed_price. Clients must accept values not listed.
`starts_at` Starts	`string \| null; format date-time`
`ends_at` Ends	`string \| null; format date-time`
`species` Species	`array<common.ref>; max items 10` Empty means the event accepts every species.
`species[].kind` Kind	`string`
`species[].id` Id	`string`
`species[].title` Title	`string`
`species[].url` Url	`string \| null; format uri`
`species_truncated` Species truncated	`boolean \| null`
`organizer` Organizer	`common.actor_ref \| null`
`organizer.kind` Kind	`string` Known values: user, org. Clients must accept values not listed.
`organizer.id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`organizer.title` Title	`string`
`organizer.url` Url	`string; format uri`
`organizer.avatar` Avatar	`common.avatar \| null`
`summary` Summary	`string \| null; max length 300` The teaser, else the description, as plain text.
`summary_truncated` Summary truncated	`boolean \| null`
`image` Image	`common.image \| null`
`image.alt` Alt	`string \| null`
`image.thumb` Thumb	`string \| null; format uri`
`image.square` Square	`string \| null; format uri`
`image.large` Large	`string \| null; format uri`
`active_lot_count` Active lots	`integer \| null; min 0` The number of listings /api/v1/listings?event=<id> returns; it can be lower than the count on the events page.
`description` Description	`string \| null; max length 4000` The organizer's text as Markdown: bold and italic kept as the page shows them, creatures.com links linked, other URLs as inline code.
`description_truncated` Description truncated	`boolean \| null`
`teaser` Teaser	`string \| null; max length 300`
`teaser_truncated` Teaser truncated	`boolean \| null`
`breeds` Breeds	`array<common.ref>; max items 20` Empty means every breed of the accepted species.
`breeds[].kind` Kind	`string`
`breeds[].id` Id	`string`
`breeds[].title` Title	`string`
`breeds[].url` Url	`string \| null; format uri`
`breeds_truncated` Breeds truncated	`boolean \| null`
`accepts` Accepts	`array<string>; max items 2`
`no_buyer_fees` No buyer fees	`boolean \| null` True when the organizer covers buyer fees for every lot.
`application_deadline` Application deadline	`string \| null; format date-time`
`applications_open` Applications open	`boolean \| null` True while the event is upcoming or live and before the application deadline.
`soft_close` Soft close	`object \| null` A bid within trigger_window_seconds of the close extends it by extension_seconds (the auction code's rule for event lots).
`soft_close.trigger_window_seconds` Trigger window (seconds)	`integer`
`soft_close.extension_seconds` Extension (seconds)	`integer`
`lot_count` Lots	`integer \| null; min 0` Every lot that passes the listing get gate, in any status (/api/v1/listings?event=<id>&status=all).
`lots` Lots	`null \| object` Null unless include=lots: up to 5 lot summaries in the organizer's order; list_url pages through all of them.
`lots.data` Lots	`array<listing.summary>; max items 5`
`lots.data[].kind` Kind	`string; value "listing"`
`lots.data[].id` Id	`string; pattern ^[0-9A-Za-z]{8}$`
`lots.data[].title` Title	`string; max length 200` The animal's display name.
`lots.data[].url` Page	`string; format uri`
`lots.data[].updated_at` Updated	`string; format date-time`
`lots.data[].status` Status code	`string \| null` Public status, never the stored one: scheduled = auction start in the future; ending = past its close time, awaiting the close job; sale_pending = reserved or in payment. Known values: active, scheduled, ending, sale_pending, auction_won, sold, reserve_not_met, ended_no_bids, cancelled, paused. Clients must accept values not listed.
`lots.data[].status_label` Status	`string \| null`
`lots.data[].sale_type` Sale type	`string \| null` Known values: fixed_price, auction. Clients must accept values not listed.
`lots.data[].price` Price	`common.money \| null` Fixed price; for an auction the current bid, else the starting bid; for a sold listing the sale amount.
`lots.data[].buy_now_price` Buy now price	`common.money \| null` Set only while buy now is available (active, no bids).
`lots.data[].bid_count` Bids	`integer \| null` Auctions only.
`lots.data[].starts_at` Auction starts	`string \| null; format date-time`
`lots.data[].ends_at` Auction ends	`string \| null; format date-time`
`lots.data[].species` Species	`common.ref \| null`
`lots.data[].breed` Breed	`common.ref \| null` Null for the placeholder breed.
`lots.data[].genetics_label` Reported genetics	`string \| null`
`lots.data[].breed_makeup_label` Breed makeup	`string \| null`
`lots.data[].sex` Sex code	`string \| null` Raw sex; filter on this, never on sex_label. Known values: male, female, unknown. Clients must accept values not listed.
`lots.data[].sex_label` Sex	`string \| null` The page's species word, for example Doe or Wether.
`lots.data[].age_label` Age	`string \| null`
`lots.data[].registries` Registries	`array<string>; max items 5` Labels of public registrations only.
`lots.data[].registries_truncated` Registries truncated	`boolean \| null`
`lots.data[].location` Location	`common.location \| null`
`lots.data[].seller` Seller	`common.seller_ref \| null` identity_verified is null in the summary and set in the full view.
`lots.data[].image` Image	`common.image \| null`
`lots.data[].no_buyer_fee` No buyer fee	`boolean \| null`
`lots.data[].sale_event` Sale event	`common.ref \| sale_event.summary \| null` Null unless the event is public; include=sale_event gives its summary.
`lots.has_more` More lots	`boolean`
`lots.list_url` All lots	`string; format uri`

Platform fact `platform_fact.full`

Platform fact fields
Field	Type and description
`kind` Kind	`string; value "platform_fact"`
`id` Id	`string; pattern ^[a-z][a-z0-9_]{0,39}$` The topic key, for example contact.
`title` Title	`string; max length 200`
`url` Source page	`string; format uri`
`updated_at` Updated	`string; format date-time`
`summary` Summary	`string \| null; max length 300` The answer as plain text, cut to 300 characters.
`summary_truncated` Summary truncated	`boolean \| null`
`answer` Answer	`string \| null; max length 4000` The full answer as plain text.
`answer_truncated` Answer truncated	`boolean \| null`

MCP

AI assistants can read the same public data through https://creatures.com/mcp/v2. See Use Creatures in Claude and ChatGPT for connection steps and examples.

Search Creatures (search): Search public Creatures listings, animals, breeders, services, species, breeds, articles, tools, sale events and platform facts. Returns up to 5 results; pass a result id to fetch.
Fetch a Creatures record (fetch): Read one public Creatures record by an id from any result (e.g. listing:Bk3mX9pQ) or by a creatures.com link. Returns its title, text, page url and metadata.
Search animal listings (search_listings): List public animal listings on Creatures, filtered by species, breed, sex, sale type, place and price. Prices are whole US dollars. Page with next_cursor.
Find breeders and services (find_breeders_and_services): List public breeders, livestock transporters, boarding, hoof care, shearing, reproduction or processing services on Creatures. transport lists Creatures-reviewed transporters first, then directory haulers.

Shortcuts

Learn About

Find Breeders

Creatures API

Overview

Rate limits and errors

Terms

Endpoints

GET /api/v1/listings

GET /api/v1/listings/{id}

GET /api/v1/animals

GET /api/v1/animals/{id}

GET /api/v1/breeders

GET /api/v1/breeders/{id}

GET /api/v1/providers

GET /api/v1/providers/{id}

GET /api/v1/species

GET /api/v1/species/{id}

GET /api/v1/breeds

GET /api/v1/breeds/{id}

GET /api/v1/articles

GET /api/v1/articles/{id}

GET /api/v1/tools

GET /api/v1/tools/{id}

GET /api/v1/sale-events

GET /api/v1/sale-events/{id}

GET /api/v1/platform-facts

GET /api/v1/platform-facts/{id}

GET /api/v1/search

GET /api/v1/lookup

GET /api/v1/resolve

GET /api/v1/openapi.json