Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Words in the person's language: breeds, colors, ages, sizes, sex and places become filters, the rest is full-text (\"黑色柴犬\")"
},
"km": {
"type": "integer",
"maximum": 800,
"minimum": 1,
"description": "Radius, kilometres"
},
"age": {
"enum": [
"Baby",
"Young",
"Adult",
"Senior"
],
"type": "string",
"description": "Taiwan says only Young or Adult"
},
"sex": {
"enum": [
"Male",
"Female"
],
"type": "string"
},
"lang": {
"type": "string",
"maxLength": 20,
"description": "The person's language: en, es, zh-Hant, zh-Hans, ko, ja, vi, fr, ar, tl (default en)"
},
"near": {
"type": "string",
"maxLength": 60,
"description": "a Taiwan county or township in any language, a US ZIP, Zaragoza, Wien or Fukushima (福島県) (98101, 信義區, 臺北市), or lat,lon; never a street address. Nearest first; an uncovered place gets the nearest pets we hold, marked not nearby"
},
"page": {
"type": "integer",
"maximum": 10000,
"minimum": 1
},
"size": {
"enum": [
"Small",
"Medium",
"Large",
"X-Large"
],
"type": "string",
"description": "Not stated in King County or Vienna"
},
"sort": {
"enum": [
"relevance",
"newest",
"listed",
"distance",
"photo"
],
"type": "string",
"description": "photo = best photo first"
},
"breed": {
"type": "string",
"maxLength": 80,
"description": "Breed name in any language, or Wikidata id"
},
"color": {
"enum": [
"black",
"white",
"brown",
"yellow",
"grey",
"orange",
"cream",
"tabby",
"calico",
"spotted"
],
"type": "string"
},
"found": {
"enum": [
"include",
"exclude",
"only"
],
"type": "string",
"description": "Found pets (Vienna's, announced for their owners first) are included by default, marked found:true, NOT adoptable. exclude = adoptable only. Never call one adoptable"
},
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Pets per answer (find_pets default 10, show_pets 24)"
},
"miles": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Radius, miles (default 50)"
},
"photo": {
"enum": [
"good"
],
"type": "string",
"description": "good: only pets whose best photo passed our checks; unanalysed pets are left out (only Taiwan's are analysed)"
},
"place": {
"type": "object",
"properties": {
"area": {
"type": "string",
"maxLength": 60,
"description": "a Taiwan county or township in any language, a US ZIP, Zaragoza, Wien or Fukushima (福島県)"
},
"latitude": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Only with longitude, if the person shared it"
},
"longitude": {
"type": "number",
"maximum": 180,
"minimum": -180
},
"postal_code": {
"type": "string",
"maxLength": 12,
"description": "A US ZIP"
}
},
"description": "near as structured fields; never a street address",
"additionalProperties": false
},
"cursor": {
"type": "string",
"maxLength": 80,
"description": "next_cursor from the previous answer"
},
"detail": {
"enum": [
"brief",
"full"
],
"type": "string",
"description": "find_pets default brief; full = every field of pet.v1"
},
"facets": {
"type": "boolean",
"description": "Add counts by species, size, age, sex, region"
},
"region": {
"type": "string",
"maxLength": 30,
"description": "Taiwan county or city, e.g. Taipei City"
},
"country": {
"enum": [
"TW",
"US",
"ES",
"AT",
"JP"
],
"type": "string",
"description": "TW (Taiwan), US (King County WA, Montgomery County MD only), ES (Zaragoza), AT (Vienna, found pets only) or JP (Fukushima Prefecture). Not needed with near"
},
"species": {
"enum": [
"Dog",
"Cat",
"Rabbit",
"Bird",
"Small pet",
"Reptile",
"Pig",
"Barnyard"
],
"type": "string"
},
"good_with": {
"type": "array",
"items": {
"enum": [
"dogs",
"cats"
],
"type": "string"
},
"maxItems": 3,
"description": "Only pets whose listing says so; rarely stated. kids is not offered; if it is passed anyway, the answer lists pets whose listing does not say (good_with_soft, each not_stated). For such wishes prefer search_by_description"
},
"min_photo_px": {
"type": "integer",
"maximum": 4000,
"minimum": 1,
"description": "Best photo's longest side, at least, in pixels"
}
}
}