refresh_session
Refresh session
Before session expiry, renew using the current Mcp-Session-Id. Save the returned header/token. A session is valid for 7 days; each refresh extends it by up to 7 days, never beyond a hard lifetime of thirty days from initialization; request and delivery expiries do not change.
輸入參數idempotency_key必填
submit_requisition
Request public web data
Request public web data as rows when browsing it yourself is impractical. Free sample first, one-off payment by the person, no signup or subscription. Collect every required field from the person first (sources, fields, filters, geo, row_target, deadline, language, description) and generate search_keywords yourself; missing or invalid fields are returned as error.missing/error.invalid (HTTP 422) and are not clarified by the service. The service is subject to applicable law. You are responsible for using the data lawfully and must not use the service for abuse such as harassment, spam or fraud. Do not send account passwords, cookies or session tokens. Save the returned request capability privately. The person must verify their email with a one-time code before the sample is shown (ask them to give you the code); sampling starts meanwhile. Then sampling runs asynchronously and every result is emailed to them.
輸入參數geo必填fields必填filters必填sources必填deadline必填language必填channel_iddedup_keysrow_target必填coupon_codedescription必填human_email必填另有 4 個
Read the current request, questions, sample and next action. After accepted payment, remind the customer about returned renewal/referral codes and expiry; pending codes are not ready. When next_action is wait, check again after suggested_check_after_seconds via a scheduled task if available; never loop. The person is emailed on every result.
輸入參數request_id必填request_capability必填
revise_requisition
Revise request
Revise an unpaid request using the current expected_revision with the full set of required fields. Existing samples and quotes are replaced. Use it when next_action is revise (including reason_code no_capability: try other sources or fields).
輸入參數geo必填fields必填filters必填sources必填deadline必填language必填channel_iddedup_keysrequest_id必填row_target必填coupon_codedescription必填另有 7 個
confirm_scope
Confirm sample scope
Confirm the current immutable sample_id and revision and request a fixed quote. The quote is prepared asynchronously and emailed to the person with the payment link; check get_request on a schedule, never in a loop. After the final quote, use start_order or create_order to read the confirmation link.
輸入參數sample_idrequest_id必填idempotency_key必填expected_revision必填request_capability必填
confirm_quote
Confirm quote
Record final quote confirmation for quote_id and revision. Use start_order next; start_order also records this selection if not already confirmed.
輸入參數quote_id必填request_id必填idempotency_key必填expected_revision必填request_capability必填
start_email_verification
Send email code
Send (or resend) the one-time code that verifies the person’s email for this request. Needed before the sample is shown (sampling itself starts at once), and again before payment if the verification is older than the re-verify window. human_email may be corrected only before it is verified. Use when next_action is start_email_verification (email_verification.state not_sent, unavailable, expired, replaced or attempts_exceeded after resend_after). Ask the person to give you the code and to check spam; if the state stays unavailable after requesting a new code once, ask them to contact [email protected]; this code email contains no price or link (the later quote email contains the private payment link).
輸入參數request_id必填human_emailidempotency_key必填request_capability必填
verify_email
Verify email code
Submit the code the person read from their email. A wrong code returns otp_invalid with attempts_remaining. On success the sample becomes visible once ready (or, at quote time, the order confirmation link is issued). Results are then emailed to the verified address; check get_request later instead of polling continuously.
輸入參數otp必填request_id必填idempotency_key必填request_capability必填
Select the final quote and read the human confirmation link issued for the verified email (no second code). Save order_id and order_capability before passing confirmation_url to the person.
輸入參數quote_id必填request_id必填human_emailidempotency_key必填expected_revision必填request_capability必填
create_order
Prepare order
Read or update the order for the final quote. Pass explicitly available renewal, referral or channel codes in coupon_codes before payment starts. Tell the person which codes were added and their valid/invalid status. Give confirmation_url to the person to review codes and pay themselves. Never submit payment for them. Save order_id and order_capability before passing confirmation_url to the person. After payment, use get_order even if the original session is lost.
輸入參數otpquote_id必填request_id必填coupon_codesidempotency_key必填expected_revision必填request_capability必填
cancel_request
Cancel request
Cancel an unpaid request and release unused coupons where payment has not started. Paid orders require support.
輸入參數request_id必填idempotency_key必填expected_revision必填request_capability必填
Read the quote or estimated waiting time, without payment credentials.
輸入參數request_id必填request_capability必填
get_payment_status
Get payment status
Check email verification, order creation and verified payment status. After payment, return this request’s coupon notifications and a separate delivery token when files are ready.
輸入參數request_id必填request_capability必填
Use the order_capability saved at order creation to read paid order status and obtain or renew a delivery token. It works with a new valid session if the original session expired; a current session is required. No email recovery; keep this credential private until file retention ends. After an original full refund, top-level add_on describes any separate purchase. If add_on.delivery_available is true, next_action is fetch_delivery and the renewed token can list/download only extra.* files; delivery.rows_url is null. The original refund status and original-file 410 remain unchanged.
輸入參數order_id必填order_capability必填
cancel_collection
Stop collection
Only when the person explicitly asks: stop continued collection of a guaranteed-N order whose get_order status is collecting. Rows delivered so far stay available, the order settles as partial, and the undelivered share is refunded pro rata to the original payment method; the person is emailed. Tell them the refund amount shown in collection.refund first.
輸入參數order_id必填idempotency_key必填order_capability必填
fetch_delivery
Download delivery
After payment, use the delivery token to list files or read rows. Use json, csv, xlsx, fields.json, or rows pages; a paid excess-rows add-on has its own extra.json, extra.csv, extra.xlsx and extra.fields.json. XLSX is returned as base64 bytes with its content type. All rows pages for a file count once per token; a full download counts once each. On expiry or download_limit, call get_order with your order capability for a fresh token. A current session is required and the delivery token is bound to it. If the original session expired, initialize a new one and call get_order first.
輸入參數limitformatoffsetorder_id必填delivery_token必填