/tdb/reports/search

POST /api/tdb/reports/search

Price: 10 credits

Search Teikoku Databank reports — economic and industry research, business articles, bankruptcy flash reports and bankruptcy statistics — by keyword, category, topic tag, publication year and region: title, subtitle, category, tags, publication date, the full text and attached files, newest first

How to use it

At most 100 reports per query; narrow by keyword, category, tag, year or area for more. kind tells an article from a bankruptcy flash or statistics report, and an article's url goes to tdb/reports.

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 results (min: 1; max: 100)
• keyword string nullable — Words to find in the report (examples: "ゴルフ"; minLength: 1)
• year integer nullable — Publication year (min: 2013; max: 2100)
• area string nullable — Region the report is about (one of: "nationwide", "hokkaido", "tohoku", "kanto", "hokuriku", "chubu", "kinki", "chugoku", "shikoku", "kyushu_okinawa")
• category string nullable — Report category (one of: "bankruptcy", "economy", "industry", "business_knowledge")
• tag string nullable — Topic tag as the site names it (examples: "雇用・人材", "倒産集計"; minLength: 1)

Response

• @type string (default: "TdbReport")
• id string required
• url string required
• kind string required (one of: "article", "bankruptcy_flash", "bankruptcy_summary")
• section string nullable
• subtitle string nullable
• categories array (default: [])
• tags array (default: [])
• areas array (default: [])
• published_date integer nullable
• published_at integer nullable
• posted_at integer nullable
• revised_at integer nullable
• created_at integer nullable
• updated_at integer nullable
• image string nullable
• image_caption string nullable
• is_locked boolean nullable
• has_video boolean nullable
• contact string nullable
• phone string nullable
• form_url string nullable
• text string nullable
• html string nullable
• files array (default: [])
  • @type string (default: "TdbFile")
  • name string nullable
  • url string required
  • file_type string nullable
  • size_bytes integer 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.