/downdetector/companies/directory

POST /api/downdetector/companies/directory

Price: 1 credit

Browse the company directory of one Downdetector country site

How to use it

Enumerate the services one country site lists, alphabetically, when you need the whole roster rather than one lookup — for example to find every bank or carrier it tracks. Entries carry identity only: name, alias and id, with no status, so call the company endpoint per service for the outage view. `query` is a plain substring match over the name and alias, so it is literal where the search endpoint is fuzzy. This is the browsable directory rather than every service Downdetector monitors, and it is per country.

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 companies to return (min: 1; max: 3000)
• country string — Country site to read. Downdetector runs one site per country and each keeps its own service list, aliases and reports (default: "us"; one of: "ae", "ar", "at", "au", "az", "bd", "be", "bg", "bh", "br", "ca", "ch", "cl", "co", "cr", "cz", "de", "dk", "do", "dz", "ec", "eg", "es", "fi", "fr", "gb", "gr", "gt", "hk", "hr", "hu", "id", "ie", "il", "in", "it", "jo", "jp", "ke", "kr", "ma", "mx", "my", "ng", "nl", "no", "nz", "pa", "pe", "ph", "pk", "pl", "pr", "pt", "py", "ro", "rs", "sa", "se", "sg", "si", "sk", "th", "tn", "tr", "tw", "ua", "us", "uy", "ve", "vn", "za")
• query string — Case-insensitive substring matched against the company name and alias (default: ""; examples: "bank", "airline", "vodafone")
• offset integer — How many matching companies to skip before the first returned one (default: 0; min: 0)

Response

• @type string (default: "DowndetectorCompany")
• id string required
• country string required (one of: "ae", "ar", "at", "au", "az", "bd", "be", "bg", "bh", "br", "ca", "ch", "cl", "co", "cr", "cz", "de", "dk", "do", "dz", "ec", "eg", "es", "fi", "fr", "gb", "gr", "gt", "hk", "hr", "hu", "id", "ie", "il", "in", "it", "jo", "jp", "ke", "kr", "ma", "mx", "my", "ng", "nl", "no", "nz", "pa", "pe", "ph", "pk", "pl", "pr", "pt", "py", "ro", "rs", "sa", "se", "sg", "si", "sk", "th", "tn", "tr", "tw", "ua", "us", "uy", "ve", "vn", "za")
• domain string required
• name string nullable
• alias string nullable
• url string nullable
• image string nullable
• website string nullable
• status string nullable (one of: "success", "warning", "danger")
• category object nullable
  • @type string (default: "DowndetectorCategory")
  • id string nullable
  • name string nullable
  • alias string nullable
• contact object nullable
  • @type string (default: "DowndetectorContact")
  • support_url string nullable
  • email string nullable
  • phone string nullable
  • phone_extra string nullable
  • status_page_url string nullable
  • twitter_username string nullable
  • facebook_url string nullable
  • whatsapp string nullable
  • complaint_forum_url string nullable
  • complaint_forum_label string nullable
  • published boolean nullable
• page_title string nullable
• page_description string nullable
• description string nullable
• rating number nullable
• rating_count integer nullable
• reports_max integer nullable
• baseline_min integer nullable
• baseline_max integer nullable
• report_points array (default: [])
  • @type string (default: "DowndetectorReportPoint")
  • timestamp string required
  • reports integer nullable
  • baseline integer nullable
• sparkline array (default: [])
• problem_types array (default: [])
  • @type string (default: "DowndetectorProblemType")
  • id string nullable
  • name string nullable
  • reports integer nullable
  • share_percent number nullable
• indicators array (default: [])
  • @type string (default: "DowndetectorIndicator")
  • id string nullable
  • name string nullable
  • label string nullable
  • parent_id string nullable
  • parent_name string nullable
  • trending boolean nullable
• comments array (default: [])
  • @type string (default: "DowndetectorComment")
  • author string nullable
  • text string nullable
  • image string nullable
  • created_at string nullable
• top_cities array (default: [])
  • @type string (default: "DowndetectorCity")
  • id string nullable
  • name string nullable
  • alias string nullable
• shows_cities boolean nullable
• report_locations array (default: [])
  • @type string (default: "DowndetectorGeoPoint")
  • longitude number required
  • latitude number required
• map_settings object nullable
  • @type string (default: "DowndetectorMapSettings")
  • zoom integer nullable
  • height integer nullable
  • latitude number nullable
  • longitude number nullable
  • region string nullable
  • radius_km integer nullable
  • boundary_wkt string nullable
  • orientation string nullable
• tweets_domain string nullable
• related_sites array (default: [])
  • @type string (default: "DowndetectorRelatedCompany")
  • url string nullable
  • domain string nullable
  • country_code string nullable
  • country_name 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.