Search adoptable pets

get/api/v1/pets

Request

  • Base URL: https://petnecto.com
  • URL: https://petnecto.com/api/v1/pets
  • Auth: none declared

Query parameters

country'TW' | 'US' | 'ES' | 'AT'

TW (Taiwan), US (King County WA, Montgomery County MD), ES (Zaragoza), AT (Vienna, found pets)

regionstring

Taiwan county or city (with country=TW)

nearstring

US ZIP, lat,lon (rounded to ~1 km), or a Taiwan county or township name in any language

milesinteger

Radius in miles, 1-500 (default 50)

kminteger

Radius in km, 1-800 (instead of miles)

species'Dog' | 'Cat' | 'Rabbit' | 'Bird' | 'Horse' | 'Small pet' | 'Reptile' | 'Pig' | 'Barnyard'

Dog, Cat, Rabbit...

age'Baby' | 'Young' | 'Adult' | 'Senior'

Age group

size'Small' | 'Medium' | 'Large' | 'X-Large'

Size group

sex'Male' | 'Female'

Sex

good_withstring

Comma list of dogs, cats, kids. Few listings say good-with and none say kids: when no pet in scope matches, the answer lists the pets whose listing does not say (interpreted.good_with_soft, not_stated), never pets it says are not

pageinteger

Page, 1-10000 (past the last page: no pets)

cursorstring

The next_cursor of the previous answer: the next page without re-reading the ones before it

detail'full' | 'brief'

full (default: each pet as a pet.v1 record) or brief (short pets for assistants; rescues and licences once per answer)

limitinteger

Results per page, 1-50 (default 24)

qstring

Words in any of our languages, up to 200 characters. Breed, color, age, size, sex and place words become filters; the rest is full-text search

breedstring

A Wikidata breed id (Q39315) or a breed name in any language

color'black' | 'white' | 'brown' | 'yellow' | 'grey' | 'orange' | 'cream' | 'tabby' | 'calico' | 'spotted'

Color: a key or a color word in any of our languages

shelterstring

One shelter's pets, by its id (the end of its /shelters/ page address)

sort'relevance' | 'newest' | 'listed' | 'distance' | 'photo'

relevance (with q), newest, listed (strictly by listing date, newest first), distance (with near), or photo (best photo first)

photo'good'

good: only pets whose best photo passed our checks (analysed; not blurry, dark, tiny, or without a pet in it)

min_photo_pxinteger

Only pets whose best photo is at least this many pixels on its longest side (1-4000)

facets'1'

1 to add counts by species, size, age, sex, region and good-with

lang'en' | 'es' | 'zh-Hant' | 'zh-Hans' | 'ko' | 'ja' | 'vi' | 'fr' | 'ar' | 'tl'

Language for names and text (else Accept-Language)

output'json' | 'md'

md for Markdown instead of JSON

found'include' | 'exclude' | 'only'

include (default: found pets are listed with a "found" label), exclude (adoptable pets only) or only (found pets only)

format'atom'

atom for an Atom feed (RFC 4287) of this search, newest listing first: 'new dogs near me' in any feed reader, no account

Response

The answer as JSON (or Markdown with output=md)

object required

Changes

No recorded changes to this operation across all 1 revision of this API.