This documentation is for partners of Adopt-a-Pet.com, a national non-profit pet adoption advertising charity. The Adopt-a-Pet.com API (Application Programming Interface) is a series of tools that allows partners to use Adopt-a-Pet.com's pet adoption features and pet data in other applications. These tools can only be used pursuant to the contractual details of the partnership, and acknowledgement of Adopt-a-Pet.com on all pages of the implementation of these tools is required as per that contract. See Terms of Use.
\nThe Adopt-a-Pet.com API will allow partners to query the Adopt-a-Pet.com database for information that can be used to build pet searching forms, retrieve pet search results, view pet details information including pet photos, search for shelters and pets at shelters, and retrieve other relevant information.
\nThis document is intended for software developers who are already familiar with the concept of an API and object oriented programming concepts. Developers should also be familiar with the Adopt-a-Pet.com interface from a user's point of view.
\nThese are the required steps for integration of the Adopt-a-Pet.com syndicated pet search:
\nThe Adopt-a-Pet.com API provides the following features:
\nSome features may not be available to all API partners.
\nPlease make sure you protect your API key and ensure that it is not disclosed to the public. It should never be checked into source control (i.e., GitHub), or hard coded within HTML or JavaScript that could be viewed by users on your site.
\nAll requests to our API endpoint must be made using HTTPS. Your software/client must be capable of understanding and connecting to an SNI (Server Name Indication) server, using SSLv2, TLSv1+ or TLS_v2+. Any requests sent to HTTP vs HTTPS will be redirected, so it is to your advantage to send the request to HTTPS in the first place to reduce request round trip time.
\nYou must include a visible Adopt-a-Pet.com logo preceded by the words \"powered by” on all pages where this API is implemented. The logo must be a live link to https://www.adoptapet.com and must be an approved version of the logo (which can be found here). This enables animal shelters to understand where the data they see is coming from and who to contact to add their pets to the database. It also allows users to know the source of the data and who to contact regarding questions about specific pets they see. This link is not designed to draw users off the partner site, but is for informational and search engine purposes only. As such, the link must not be blocked by \"no-follow\", robots.txt or other search engine blocking methods.
\nThe API is a REST API designed to receive inputs from your custom application using HTTP GET and POST requests that are formatted with a path and a querystring or POST body. For example:
\nhttps://api.adoptapet.com/search/limited_pet_details?key=A34F48&v=2&output=json&pet_id=2342
The results of the request will be a text result formatted in one of the available output styles. From there, you can use your own output parser to break the returned data into local data structures, and then process them as you want to.
\nUsing the API functions provided, you should be able to build a site that functions much like the Adopt-a-Pet.com site, but that has your own customized user interface.
\nA note about the results of the limited_pet_search method: Exact matches (where all search criteria are met) are always returned before before inexact matches (where only some of the criteria are met). If you choose to show the inexact matches, we recommend adding clear wording to your interface that clarifies the transition in result records. For example: \"These pets aren't exactly what you asked for... but they are close!\"
\nAll API methods accept the following standard inputs.
\nkey - The API key provided to you.v - The API Version (normally v=2, unless you are asked to use a different one).output - The output format. Acceptable values are json and xml.Please look at the example Postman environments provided to setup appropriate variables for testing in both staging and production environments. Example responses are also provided here for all API calls.
\nThe output data structures will generally be one of these four types:
\nAPI function call responses will always always include a top level attribute of status and a value of ok, or fail in the event of an error. A nested error data structure will also be included in the response, and it has the following attributes:
\nThe table below describes failure error codes that may be returned from API function calls:
\n1 All requests are subject to throttling on an hourly basis. If you start receiving this error and your site traffic is high enough, please contact Adopt-a-Pet.com to discuss raising your limits.
\nExample Error Response
\n{\n \"status\":\"fail\",\n \"error\":{\n \"code\":412\n \"details\":\"Field \\\"pet_id\\\" was missing.\",\n \"msg\":\"input_missing\",\n }\n}\nThis API returns all of the elements necessary to construct a search form on the website, to provide you with the inputs you need to call the pet_search API.
\nThe data returned by this API can be considered relatively stable. Information such as breeds, colors and hair length are rarely changed, so this data is ideal for retrieving and caching long term.
\nOutput:
\nEach item in the output is an array of nested objects containing label and value. The label is used to display options to the end user, while the value is what you send to the API in the other calls in this section.
\n","urlObject":{"protocol":"https","path":["search","search_form"],"host":["{{url}}"],"query":[{"description":{"content":"(Required) API Key - set in Environment
\n","type":"text/plain"},"key":"key","value":"{{key}}"},{"description":{"content":"(Required) API Version - set in Environment
\n","type":"text/plain"},"key":"v","value":"{{version}}"},{"description":{"content":"(Required) json or xml - set in Environment
\n","type":"text/plain"},"key":"output","value":"{{output}}"},{"description":{"content":"(Required) cat, dog, rabbit, bird, reptile, small_animal, horse, farm_animal
\n","type":"text/plain"},"key":"species","value":"dog"}],"variable":[]}},"response":[{"id":"e2dd2935-9f67-472e-a737-36cc9cfecf80","name":"/search/search_form","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{url}}/search/search_form?key={{key}}&v={{version}}&output={{output}}&species=dog","protocol":"https","host":["{{url}}"],"path":["search","search_form"],"query":[{"key":"key","value":"{{key}}","description":"(Required) API Key - set in Environment"},{"key":"v","value":"{{version}}","description":"(Required) API Version - set in Environment"},{"key":"output","value":"{{output}}","description":"(Required) json or xml - set in Environment"},{"key":"species","value":"dog","description":"(Required) cat, dog, rabbit, bird, reptile, small_animal, horse, farm_animal"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Apr 2019 14:37:22 GMT"},{"key":"Content-Type","value":"application/json; charset=ISO-8859-1"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"age\": [\n {\n \"label\": \"Any\",\n \"value\": \"\"\n },\n {\n \"value\": \"young\",\n \"label\": \"Young\"\n },\n {\n \"label\": \"Adult\",\n \"value\": \"adult\"\n },\n {\n \"label\": \"Senior\",\n \"value\": \"senior\"\n },\n {\n \"value\": \"puppy\",\n \"label\": \"Puppy\"\n }\n ],\n \"sex\": [\n {\n \"value\": \"\",\n \"label\": \"Any\"\n },\n {\n \"label\": \"Male\",\n \"value\": \"m\"\n },\n {\n \"label\": \"Female\",\n \"value\": \"f\"\n }\n ],\n \"status\": \"ok\",\n \"geo_range\": [\n {\n \"value\": \"35\",\n \"label\": \"Less than 35 miles (55 km)\"\n },\n {\n \"value\": \"50\",\n \"label\": \"Less than 50 miles (80 km)\"\n },\n {\n \"value\": \"75\",\n \"label\": \"Less than 75 miles (120 km)\"\n },\n {\n \"value\": \"100\",\n \"label\": \"Less than 100 miles (160 km)\"\n },\n {\n \"label\": \"Less than 250 miles (400 km)\",\n \"value\": \"250\"\n }\n ],\n \"pet_size_range_id\": [\n {\n \"label\": \"Any\",\n \"value\": \"\"\n },\n {\n \"value\": 1,\n \"label\": \"Small 25 lbs (11 kg) or less\"\n },\n {\n \"label\": \"Med. 26-60 lbs (12-27 kg)\",\n \"value\": 2\n },\n {\n \"label\": \"Large 61-100 lbs (28-45 kg)\",\n \"value\": 3\n },\n {\n \"value\": 4,\n \"label\": \"X-Large 101 lbs (46 kg) or more\"\n }\n ],\n \"color_id\": [\n {\n \"label\": \"Any\",\n \"value\": \"\"\n },\n {\n \"label\": \"Black\",\n \"value\": 152\n },\n {\n \"value\": 153,\n \"label\": \"Brindle\"\n },\n {\n \"label\": \"Brown/Chocolate\",\n \"value\": 154\n },\n {\n \"label\": \"Gray/Blue/Silver/Salt & Pepper\",\n \"value\": 155\n },\n {\n \"label\": \"Merle\",\n \"value\": 156\n },\n {\n \"label\": \"Red/Golden/Orange/Chestnut\",\n \"value\": 157\n },\n {\n \"value\": 158,\n \"label\": \"Silver & Tan (Yorkie colors)\"\n },\n {\n \"value\": 159,\n \"label\": \"Tan/Yellow/Fawn\"\n },\n {\n \"value\": 160,\n \"label\": \"Tricolor (Tan/Brown & Black & White)\"\n },\n {\n \"value\": 161,\n \"label\": \"White\"\n }\n ],\n \"breed_id\": [\n {\n \"label\": \"Any\",\n \"value\": \"\"\n },\n {\n \"value\": \"real=187\",\n \"label\": \"Affenpinscher\"\n },\n {\n \"label\": \"Afghan Hound\",\n \"value\": \"real=1\"\n },\n {\n \"value\": \"super=1015\",\n \"label\": \"\\\"Ain't Nothin' but a Hound Dog!\\\"\"\n },\n {\n \"label\": \"Airedale Terrier\",\n \"value\": \"real=2\"\n },\n {\n \"label\": \"Akbash\",\n \"value\": \"real=800\"\n },\n {\n \"value\": \"real=3\",\n \"label\": \"Akita\"\n },\n {\n \"value\": \"real=4\",\n \"label\": \"Alaskan Malamute\"\n },\n {\n \"label\": \"American Bulldog\",\n \"value\": \"real=361\"\n },\n {\n \"label\": \"American Eskimo Dog\",\n \"value\": \"real=5\"\n },\n {\n \"value\": \"real=1167\",\n \"label\": \"American Hairless Terrier\"\n },\n {\n \"label\": \"American Pit Bull Terrier\",\n \"value\": \"real=801\"\n },\n {\n \"value\": \"real=1082\",\n \"label\": \"American Staffordshire Terrier\"\n },\n {\n \"label\": \"American Water Spaniel\",\n \"value\": \"nick=1030\"\n }\n ]\n}"}],"_postman_id":"cfd44286-aa56-47f0-b647-b19858c27bf2"},{"name":"/search/pet_search","id":"233715bc-7810-4f0f-bd75-a9a1cccd5b13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; charset=UTF8"}],"url":"https://{{url}}/search/pet_search?key={{key}}&v={{version}}&output={{output}}&city_or_zip=47374&geo_range=50&species=dog&breed_id=real=801&sex=m&age=young&color_id=54&pet_size_range_id=2&hair=&bonded_pair=&special_needs=&include_mixes=&added_after=&start_number=1&end_number=50&meta_only=0","description":"This endpoint does the actual search that returns a list of pets that match the search. Each pet is returned with a very limited amount of details to display a search results page. All returned pets, if any, are ordered by distance, closest to nearest from the city_or_zip provided.
If additional info is needed on the pet, a call to /search/limited_pet_details would need to be made.
NOTE: Once the data is returned for the pets in this API, there is no need to download any further information (pet details, images, etc.) unless the user clicks on a pet to view the specific details. You may display the information from /search/limited_pet_details using the details_url provided in the returned data structure for the pet. Once the data is returned from that call, there is a pet_details_url in the data that links to the pet's official page on Adopt-a-Pet.com.
In all cases, images should be loaded from the URL provided in the API results. All images are hosted on AWS CloudFront for optimal caching and viewing by the end users from their closest server.
\nThe returned data structure includes the following. Please note that unless otherwise noted, within the actual pet object values returned are the display values for the user. This is the equivalent to the label returned for that data type in the /search/search_form call, not the id or value that is submitted to the API.
Output:
\n/search/limited_pet_details)(Required) API Key - set in Environment
\n","type":"text/plain"},"key":"key","value":"{{key}}"},{"description":{"content":"(Required) API Version - set in Environment
\n","type":"text/plain"},"key":"v","value":"{{version}}"},{"description":{"content":"(Required) json or xml - set in Environment
\n","type":"text/plain"},"key":"output","value":"{{output}}"},{"description":{"content":"(Required) US zip code or CA postal code (with space), or \"City, ST\"
\n","type":"text/plain"},"key":"city_or_zip","value":"47374"},{"description":{"content":"(Required) Miles/km to search (miles/km set automatically based on city_or_zip value)
\n","type":"text/plain"},"key":"geo_range","value":"50"},{"description":{"content":"(Required) cat, dog, rabbit, bird, reptile, small_animal, horse, farm_animal
\n","type":"text/plain"},"key":"species","value":"dog"},{"description":{"content":"See /search/search_form for values.
\n","type":"text/plain"},"key":"breed_id","value":"real=801"},{"description":{"content":"m or f (all species except reptile).
\n","type":"text/plain"},"key":"sex","value":"m"},{"description":{"content":"puppy, kitten, young, adult, senior
\n","type":"text/plain"},"key":"age","value":"young"},{"description":{"content":"dog, cat, and horse only. See /search/search_form for values.
\n","type":"text/plain"},"key":"color_id","value":"54"},{"description":{"content":"all species except small_animal and cat. See /search/search_form for values.
\n","type":"text/plain"},"key":"pet_size_range_id","value":"2"},{"description":{"content":"cat and rabbit only. See /search/search_form for values.
\n","type":"text/plain"},"key":"hair","value":""},{"description":{"content":"Boolean, 1 or 0
\n","type":"text/plain"},"key":"bonded_pair","value":""},{"description":{"content":"Boolean, 1 or 0
\n","type":"text/plain"},"key":"special_needs","value":""},{"description":{"content":"rabbit and horse only. Defaults to 1.
\n","type":"text/plain"},"key":"include_mixes","value":""},{"description":{"content":"timestamp. Only pets added after this date/time will be returned.
\n","type":"text/plain"},"key":"added_after","value":""},{"description":{"content":"default 1 - used for pagination
\n","type":"text/plain"},"key":"start_number","value":"1"},{"description":{"content":"default 50, max 500 - used for pagination
\n","type":"text/plain"},"key":"end_number","value":"50"},{"description":{"content":"Boolean, 1 or 0. If this is included, only result counts are return, no actual data.
\n","type":"text/plain"},"key":"meta_only","value":"0"}],"variable":[]}},"response":[{"id":"0db3ddb9-6cbf-4974-97f6-c54bd4db2b34","name":"/search/pet_search Dog Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; charset=UTF8"}],"url":{"raw":"https://{{url}}/search/pet_search?key={{key}}&v={{version}}&output={{output}}&city_or_zip=47374&geo_range=50&species=dog&breed_id=real=801&sex=m&age=young&start_number=1&end_number=50","protocol":"https","host":["{{url}}"],"path":["search","pet_search"],"query":[{"key":"key","value":"{{key}}","description":"(Required) API Key - set in Environment"},{"key":"v","value":"{{version}}","description":"(Required) API Version - set in Environment"},{"key":"output","value":"{{output}}","description":"(Required) json or xml - set in Environment"},{"key":"city_or_zip","value":"47374","description":"(Required) US zip code or CA postal code (with space), or \"City, ST\" "},{"key":"geo_range","value":"50","description":"(Required) Miles/km to search (miles/km set automatically based on city_or_zip value)"},{"key":"species","value":"dog","description":"(Required) cat, dog, rabbit, bird, reptile, small_animal, horse, farm_animal"},{"key":"breed_id","value":"real=801","description":"See /search/search_form for values."},{"key":"sex","value":"m","description":"m or f (all species except reptile)."},{"key":"age","value":"young","description":"puppy, kitten, young, adult, senior"},{"key":"color_id","value":"54","description":"dog, cat, and horse only. See /search/search_form for values.","disabled":true},{"key":"pet_size_range_id","value":"2","description":"all species except small_animal and cat. See /search/search_form for values.","disabled":true},{"key":"hair","value":"","description":"cat and rabbit only. See /search/search_form for values.","disabled":true},{"key":"bonded_pair","value":"","description":"Boolean, 1 or 0","disabled":true},{"key":"special_needs","value":"","description":"Boolean, 1 or 0","disabled":true},{"key":"include_mixes","value":"","description":"rabbit and horse only. Defaults to 1.","disabled":true},{"key":"added_after","value":"","description":"timestamp. Only pets added after this date/time will be returned.","disabled":true},{"key":"start_number","value":"1","description":"default 1 - used for pagination"},{"key":"end_number","value":"50","description":"default 50, max 500 - used for pagination"},{"key":"meta_only","value":"0","description":"Boolean, 1 or 0. If this is included, only result counts are return, no actual data.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Apr 2019 18:24:12 GMT"},{"key":"Content-Type","value":"application/json; charset=ISO-8859-1"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"returned_nonexact_matches\": 0,\n \"pets_meta\": {\n \"sex\": {\n \"m\": 47\n },\n \"special_needs\": {\n \"0\": 23,\n \"1\": 1\n },\n \"pet_size_range_id\": {\n \"2\": 31,\n \"3\": 16\n },\n \"hosting_facility\": {\n \"shelter\": 38,\n \"rescue\": 9\n },\n \"color_id\": {\n \"45\": 6,\n \"47\": 7,\n \"49\": 5,\n \"51\": 3,\n \"54\": 11,\n \"59\": 1,\n \"60\": 2,\n \"61\": 1,\n \"62\": 1,\n \"66\": 3,\n \"68\": 2,\n \"93\": 1\n },\n \"age\": {\n \"young\": 47\n },\n \"purebred\": {\n \"0\": 43,\n \"1\": 1\n },\n \"bonded_pair\": {\n \"0\": 47\n }\n },\n \"status\": \"ok\",\n \"returned_pets\": 1,\n \"pets\": [\n {\n \"order\": 1,\n \"large_results_photo_url\": \"https://pet-uploads-staging.adoptapet.com/4/f/f/401275547.jpg\",\n \"large_results_photo_width\": 200,\n \"results_photo_width\": 68,\n \"addr_state_code\": \"IN\",\n \"details_url\": \"https://www-staging.adoptapet.com/pet/24127578-richmond-indiana-pit-bull-terrier-mix\",\n \"large_results_photo_height\": 200,\n \"results_photo_url\": \"https://pet-uploads-staging.adoptapet.com/4/9/2/401275545.jpg\",\n \"size\": \"Med. 26-60 lbs (12-27 kg)\",\n \"addr_city\": \"Richmond\",\n \"secondary_breed\": \"Pointer\",\n \"sex\": \"m\",\n \"primary_breed\": \"Pit Bull Terrier\",\n \"pet_id\": \"24127578\",\n \"age\": \"young\",\n \"pet_name\": \"Petey\",\n \"results_photo_height\": 90\n }\n ],\n \"total_pets\": 47,\n \"returned_exact_matches\": 1\n}"},{"id":"50f27476-81b2-4aea-9073-25e42120e621","name":"/search/pet_search Cat Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; charset=UTF8"}],"url":{"raw":"https://{{url}}/search/pet_search?key={{key}}&v={{version}}&output={{output}}&city_or_zip=47374&geo_range=50&species=cat&start_number=1&end_number=50","protocol":"https","host":["{{url}}"],"path":["search","pet_search"],"query":[{"key":"key","value":"{{key}}","description":"(Required) API Key - set in Environment"},{"key":"v","value":"{{version}}","description":"(Required) API Version - set in Environment"},{"key":"output","value":"{{output}}","description":"(Required) json or xml - set in Environment"},{"key":"city_or_zip","value":"47374","description":"(Required) US zip code or CA postal code (with space), or \"City, ST\" "},{"key":"geo_range","value":"50","description":"(Required) Miles/km to search (miles/km set automatically based on city_or_zip value)"},{"key":"species","value":"cat","description":"(Required) cat, dog, rabbit, bird, reptile, small_animal, horse, farm_animal"},{"key":"breed_id","value":"real=801","description":"See /search/search_form for values.","disabled":true},{"key":"sex","value":"m","description":"m or f (all species except reptile).","disabled":true},{"key":"age","value":"young","description":"puppy, kitten, young, adult, senior","disabled":true},{"key":"color_id","value":"54","description":"dog, cat, and horse only. See /search/search_form for values.","disabled":true},{"key":"pet_size_range_id","value":"2","description":"all species except small_animal and cat. See /search/search_form for values.","disabled":true},{"key":"hair","value":"","description":"cat and rabbit only. See /search/search_form for values.","disabled":true},{"key":"bonded_pair","value":"","description":"Boolean, 1 or 0","disabled":true},{"key":"special_needs","value":"","description":"Boolean, 1 or 0","disabled":true},{"key":"include_mixes","value":"","description":"rabbit and horse only. Defaults to 1.","disabled":true},{"key":"added_after","value":"","description":"timestamp. Only pets added after this date/time will be returned.","disabled":true},{"key":"start_number","value":"1","description":"default 1 - used for pagination"},{"key":"end_number","value":"50","description":"default 50, max 500 - used for pagination"},{"key":"meta_only","value":"0","description":"Boolean, 1 or 0. If this is included, only result counts are return, no actual data.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 19 Apr 2019 14:26:02 GMT"},{"key":"Content-Type","value":"application/json; charset=ISO-8859-1"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"returned_nonexact_matches\": 0,\n \"pets_meta\": {\n \"sex\": {\n \"m\": 469,\n \"f\": 552\n },\n \"color_id\": {\n \"1\": 275,\n \"2\": 20,\n \"4\": 54,\n \"5\": 82,\n \"6\": 1,\n \"7\": 30,\n \"8\": 117,\n \"9\": 18,\n \"10\": 94,\n \"11\": 12,\n \"12\": 33,\n \"13\": 42,\n \"14\": 11,\n \"15\": 8,\n \"20\": 23,\n \"21\": 1,\n \"22\": 20,\n \"23\": 73,\n \"44\": 9,\n \"100\": 13,\n \"101\": 7,\n \"102\": 3,\n \"104\": 13\n },\n \"bonded_pair\": {\n \"0\": 1006,\n \"1\": 16\n },\n \"special_needs\": {\n \"0\": 397,\n \"1\": 19\n },\n \"purebred\": {\n \"0\": 693,\n \"1\": 181\n },\n \"pet_size_range_id\": {\n \"1\": 1\n },\n \"age\": {\n \"young\": 301,\n \"adult\": 541,\n \"kitten\": 103,\n \"senior\": 59\n },\n \"hair_length\": {\n \"medium\": 17,\n \"long\": 15,\n \"short\": 204\n },\n \"hosting_facility\": {\n \"shelter\": 780,\n \"rescue\": 242\n }\n },\n \"returned_pets\": 1,\n \"pets\": [\n {\n \"pet_id\": \"24668361\",\n \"large_results_photo_url\": \"https://pet-uploads.adoptapet.com/a/8/3/393853360.jpeg\",\n \"results_photo_height\": 90,\n \"addr_state_code\": \"IN\",\n \"details_url\": \"https://www.adoptapet.com/pet/24668361-richmond-indiana-cat\",\n \"results_photo_url\": \"https://pet-uploads.adoptapet.com/5/9/7/393853371.jpeg\",\n \"order\": 1,\n \"large_results_photo_height\": 200,\n \"addr_city\": \"Richmond\",\n \"sex\": \"m\",\n \"pet_name\": \"Gus\",\n \"size\": null,\n \"secondary_breed\": \"Domestic Shorthair\",\n \"results_photo_width\": 68,\n \"large_results_photo_width\": 200,\n \"primary_breed\": \"Domestic Shorthair\",\n \"age\": \"adult\"\n }\n ],\n \"status\": \"ok\",\n \"total_pets\": 1022,\n \"returned_exact_matches\": 1\n}"}],"_postman_id":"233715bc-7810-4f0f-bd75-a9a1cccd5b13"},{"name":"/search/limited_pet_details","id":"24a922d6-d681-4dee-acdd-b5ac29af7235","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{url}}/search/limited_pet_details?key={{key}}&v={{version}}&output={{output}}&pet_id=24127578","description":"This end point provides the full details on the pet to display a general Pet Details page. If the user desires to ask about a pet, then the link provided in the pet_details_url must be made available on the page as a link for the user to click. You may want to have target='_blank' on that link if you want the user to open our page in a new window/tab.
Output:
\n(Required) API Key - set in Environment
\n","type":"text/plain"},"key":"key","value":"{{key}}"},{"description":{"content":"(Required) API Version - set in Environment
\n","type":"text/plain"},"key":"v","value":"{{version}}"},{"description":{"content":"(Required) json or xml - set in Environment
\n","type":"text/plain"},"key":"output","value":"{{output}}"},{"description":{"content":"(Required) Specific pet id obtained from /search/pet_search API
\n","type":"text/plain"},"key":"pet_id","value":"24127578"}],"variable":[]}},"response":[{"id":"f0eb17e9-cc93-417c-93c0-12d1760de742","name":"/search/limited_pet_details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{url}}/search/limited_pet_details?key={{key}}&v={{version}}&output={{output}}&pet_id=24127578","protocol":"https","host":["{{url}}"],"path":["search","limited_pet_details"],"query":[{"key":"key","value":"{{key}}","description":"(Required) API Key - set in Environment"},{"key":"v","value":"{{version}}","description":"(Required) API Version - set in Environment"},{"key":"output","value":"{{output}}","description":"(Required) json or xml - set in Environment"},{"key":"pet_id","value":"24127578","description":"(Required) Specific pet id obtained from /search/pet_search API"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Apr 2019 15:38:29 GMT"},{"key":"Content-Type","value":"application/json; charset=ISO-8859-1"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"pet\": {\n \"pet_id\": 24127578,\n \"sex\": \"Male\",\n \"purebred\": 0,\n \"automap\": 1,\n \"size\": \"Med. 26-60 lbs (12-27 kg)\",\n \"addr_city\": \"Richmond\",\n \"act_quickly\": 0,\n \"hair_length\": null,\n \"pet_code\": \"13910770-D2018706\",\n \"pet_name\": \"Petey\",\n \"color\": null,\n \"age\": \"Young\",\n \"special_needs\": 0,\n \"addr_state_code\": \"IN\",\n \"primary_breed\": \"Pit Bull Terrier\",\n \"species\": \"Dog\",\n \"secondary_breed\": \"Pointer\",\n \"video_url\": null,\n \"pet_details_url\": \"https://www-staging.adoptapet.com/pet/24127578-richmond-indiana-pit-bull-terrier-mix\",\n \"last_modified\": \"2019-04-08T07:27:07\",\n\t \"images\": [\n\t {\n\t \"thumbnail_width\": 125,\n\t \"thumbnail_url\": \"https://pet-uploads-staging.adoptapet.com/7/8/b/401275544.jpg\",\n\t \"original_height\": 329,\n\t \"thumbnail_height\": 167,\n\t \"original_url\": \"https://pet-uploads-staging.adoptapet.com/2/b/7/401275542.jpg\",\n\t \"original_width\": 247\n\t }\n\t ]\n }\n}"}],"_postman_id":"24a922d6-d681-4dee-acdd-b5ac29af7235"}],"id":"570fce68-eac4-4e93-ad19-1e7ce8b6b619","description":"These endpoints are used to gather the information you need to place a custom pet search tool on your site, perform pet searches and get details on a pet to display to the end user.
\n","event":[{"listen":"prerequest","script":{"id":"aa472284-539a-402f-a6a1-720e94c41714","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f4fef375-c483-4a34-8d5c-8b0026e58620","type":"text/javascript","exec":[""]}}],"_postman_id":"570fce68-eac4-4e93-ad19-1e7ce8b6b619"},{"name":"Support","item":[],"id":"6a1e0dfd-90af-4ccb-972c-cb6f22875c64","description":"Implementation and ongoing technical support for the Adopt-a-Pet.com API is primarily provided via email, although other methods such as telephone and/or video conference may be provided during initial phases of implementation as needed.
\nOur regular business hours for support are 9am to 6pm, Monday through Friday, US Eastern (New York) time.
\nQuestions and/or issues related to implementation and the technical usage of the API should be directed to api-support@adoptapet.com. Our technical support team will respond to your request within one business day at the latest, usually much sooner. In cases where an immediate answer is not available, we will at least acknowledge your request and provide you with an ETA for a final response.
\nPlease Note: This is for technical and implementation support only. Please use the address provided during your partnership negotiations with Adopt-a-Pet.com for any contract and/or relationship support issues.
\n","_postman_id":"6a1e0dfd-90af-4ccb-972c-cb6f22875c64"},{"name":"Terms of Use","item":[],"id":"3f3c7535-c0aa-4858-9413-a561b4473d58","description":"Use of the Adopt-a-Pet.com syndicated search API is strictly limited to contractually agreed upon partner organizations, and only for the contractually agreed upon time period. Any other use of the API for any other reason or by any other entity is strictly prohibited. By using the Adopt-a-Pet.com API (the \"API\"), Partner Organizations (\"You\") accept and agree to be bound by the following terms and conditions (the \"Terms of Use\").
\n1.1 Description of API. The API consists of code that allows you to embed a homeless pet search on your site that draws its real-time data from the Adopt-a-Pet.com database of homeless pets.
\n1.2 Modifications. Adopt-a-Pet.com reserves the right to release subsequent versions of the API and to require You to obtain and use the most recent version. Adopt-a-Pet.com may modify the Terms of Use at any time with or without notice, and will inform you if any such change is made.
\nThe Service may be used only for services that are contractually agreed upon in writing with Adopt-a-Pet.com.
\nYou agree that You are responsible for proper use of the API and the data you have access to. Such proper use is the use agreed upon in the signed contract, and is designed to display pets for adoption and promote homeless pet adoption at Adopt-a-Pet.com partner shelters.
\nBy way of example, and not as a limitation, You agree that when using the Service, You will not:
\nAdopt-a-Pet.com reserves the right to cancel the use of the API at any time if:
\nFor purposes of the Terms of Use, \"Intellectual Property Rights\" shall mean any and all rights existing from time to time under patent law, copyright law, semiconductor chip protection law, moral rights law, trade secret law, trademark law, unfair competition law, publicity rights law, privacy rights law, and any and all other proprietary rights, and any and all applications, renewals, extensions and restorations thereof, now or hereafter in force and effect worldwide. As between You and Adopt-a-Pet.com, You acknowledge that Adopt-a-Pet.com owns all right, title and interest, including without limitation all Intellectual Property Rights, in and to the Service and that You shall not acquire any right, title, or interest in or to the Service, except as expressly set forth in the Terms of Use and the signed contract with Adopt-a-Pet.com.
\nFor purposes of the Terms of Use, \"Adopt-a-Pet.com Logo and Brand\" shall be defined as the trade names, trademarks, service marks, logos, domain names, and other distinctive brand features of Adopt-a-Pet.com. Adopt-a-Pet.com hereby grants to You a nontransferable, nonsublicenseable, nonexclusive license during the Term to display Adopt-a-Pet.com Logo and Brand for the purpose of promoting or advertising that You use the API Service in accordance with a signed agreement with Adopt-a-Pet.com.
\nYou understand and agree that Adopt-a-Pet.com has the sole discretion to determine whether your use of Adopt-a-Pet.com brand features is in accordance with the above restrictions.
\nYou agree to hold harmless and indemnify Adopt-a-Pet.com, and its subsidiaries, affiliates, officers, agents, and employees, advertisers or partners, from and against any third party claim arising from or in any way related to your use of the API, violation of these Terms of Use or any other actions connected with use of Adopt-a-Pet.com services, including any liability or expense arising from all claims, losses, damages (actual and consequential), suits, judgments, litigation costs and attorneys' fees, of every kind and nature.
\nYOU EXPRESSLY UNDERSTAND AND AGREE THAT ANY MATERIAL DOWNLOADED OR OTHERWISE OBTAINED THROUGH THE SERVICE IS DONE AT YOUR OWN DISCRETION AND RISK AND THAT YOU WILL BE SOLELY RESPONSIBLE FOR ANY DAMAGE TO YOUR COMPUTER SYSTEM OR LOSS OF DATA THAT RESULTS FROM THE DOWNLOAD OF ANY SUCH MATERIAL.
\nYOU EXPRESSLY UNDERSTAND AND AGREE THAT ADOPT-A-PET.COM SHALL NOT BE LIABLE TO YOU FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR EXEMPLARY DAMAGES, INCLUDING BUT NOT LIMITED TO, DAMAGES FOR LOSS OF PROFITS, GOODWILL, USE, DATA OR OTHER INTANGIBLE LOSSES, RESULTING FROM: (i) THE USE OR THE INABILITY TO USE THE SERVICE; (ii) THE COST OF PROCUREMENT OF SUBSTITUTE GOODS AND SERVICES RESULTING FROM ANY GOODS, DATA, INFORMATION OR SERVICES PURCHASED OR OBTAINED OR MESSAGES RECEIVED OR trANSACTIONS ENTERED INTO THROUGH OR FROM THE SERVICE; (iii) UNAUTHORIZED ACCESS TO OR ALTERATION OF YOUR trANSMISSIONS OR DATA; (iv) STATEMENTS OR CONDUCT OF ANY THIRD PARTY ON THE SERVICE; OR (v) ANY OTHER MATTER RELATING TO THE SERVICE.
\n","event":[{"listen":"prerequest","script":{"id":"5c63849c-85bf-4ac8-9fbf-1f7261b6a91f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0131f63f-b283-4c7c-b8da-95779957188c","type":"text/javascript","exec":[""]}}],"_postman_id":"3f3c7535-c0aa-4858-9413-a561b4473d58"}],"event":[{"listen":"prerequest","script":{"id":"24725340-9263-4f8f-8475-4d289aa9182b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1dceccf8-33c1-4425-aa03-49b889bb30bb","type":"text/javascript","exec":[""]}}],"variable":[{"key":"species","value":"dog"},{"key":"city_or_zip","value":"47374"},{"key":"geo_range","value":"50"},{"key":"breed_id","value":"real=801"},{"key":"sex","value":"m"},{"key":"age","value":"young"},{"key":"color_id","value":"54"},{"key":"pet_size_range_id","value":"2"},{"key":"hair","value":""},{"key":"bonded_pair","value":""},{"key":"special_needs","value":""},{"key":"include_mixes","value":""},{"key":"added_after","value":""},{"key":"start_number","value":"1"},{"key":"end_number","value":"50"},{"key":"meta_only","value":"0"},{"key":"pet_id","value":"24127578"},{"key":"adopts_out","value":"dogs"}]}