/miit_icp/attachments

POST /api/miit_icp/attachments

Price: 10 credits

Download one attachment of an ICP filing notice or policy document from China's MIIT filing portal: the file's name, media type, size in bytes and its content as base64.

How to use it

Urls come from the attachments of miit_icp/notices/search and miit_icp/policies/search. The clean-up lists are mostly xlsx spreadsheets, some zip or rar archives.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• url string required — Attachment url from miit_icp/notices/search or miit_icp/policies/search (examples: "https://beian.miit.gov.cn/cms_files/filemanager/431831678/attach/202112/f8be987d88dd4a6f900566f0fd138971.pdf"; minLength: 1)

Response

• @type string (default: "MiitIcpAttachmentFile")
• url string required
• file_name string nullable
• content_type string nullable
• size_bytes integer required
• content_base64 string required

Errors

• 422 — A url outside the portal's attachment files 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 — No file at that url 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.