/copart/locations/search

POST /api/copart/locations/search

Price: 20 credits

List Copart yards across North America, Europe and the Middle East, optionally narrowed to countries or states, with address, coordinates, phone and weekday hours for each.

How to use it

Find the Copart yards in a country or state, for example the ones nearest a buyer. Pass a yard id to copart/locations for sale day, managers and mailing address.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of yards to return (min: 1)
• countries array — Countries whose yards to include (default: []; one of: "USA", "CAN", "GBR", "IRL", "ARE", "BHR", "OMN")
• state_codes array — Two-letter state or province codes, as in the state_code field (default: []; examples: ["TX","CA"])

Response

• @type string (default: "CopartLocation")
• id string required
• url string nullable
• name string nullable
• short_name string nullable
• address_line_1 string nullable
• address_line_2 string nullable
• city string nullable
• state_code string nullable
• state string nullable
• country_code string nullable
• country string nullable
• postal_code string nullable
• postal_code_extension string nullable
• latitude number nullable
• longitude number nullable
• phone string nullable
• fax string nullable
• currency string nullable
• time_zone string nullable
• sale_day string nullable
• sale_time string nullable
• pre_bid_ends_before string nullable
• site_codes array (default: [])
• operating_country_code string nullable
• is_virtual boolean nullable
• has_wifi boolean nullable
• is_bid_eligibility_enabled boolean nullable
• general_manager string nullable
• general_manager_email string nullable
• regional_manager string nullable
• regional_manager_email string nullable
• vice_president_email string nullable
• office_hours array (default: [])
  • @type string (default: "CopartLocationHours")
  • day string required
  • opens_at string nullable
  • closes_at string nullable
  • status string nullable
• business_hours array (default: [])
  • @type string (default: "CopartLocationHours")
  • day string required
  • opens_at string nullable
  • closes_at string nullable
  • status string nullable
• mailing_address object nullable
  • @type string (default: "CopartLocationMailingAddress")
  • address_line_1 string nullable
  • address_line_2 string nullable
  • city string nullable
  • state_code string nullable
  • state string nullable
  • country_code string nullable
  • country string nullable
  • postal_code string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.