scrape

Get a scrape request's status and result

get/v1/scrape/{request_id}

Request

  • Base URL: https://barchin.net/api
  • URL: https://barchin.net/api/v1/scrape/{request_id}
  • Auth: HTTP bearer

Path parameters

request_idstring uuid required

Query parameters

include_htmlboolean

false: metadata only, no HTML

format'html' | 'markdown' | 'text'

Result format. markdown/text are derived from the stored HTML at read time at no extra cost.

max_charsinteger nullable

Truncate markdown/text to this many characters; sets truncated=true.

Response

Successful Response

request_idstring uuid required
urlstring required
js_enabledboolean required
wait_forstring nullable
wait_msinteger
freshboolean
accept_binaryboolean
mode'auto' | 'manual' required
countrystring nullable
proxy_requested'datacenter' | 'residential' | 'unblocker' required

The public name of a tier; this is what the API accepts and returns.

proxy_used'datacenter' | 'residential' | 'unblocker' required

The public name of a tier; this is what the API accepts and returns.

status'queued' | 'processing' | 'done' | 'failed' required
credits_heldinteger required
credits_chargedinteger nullable required
credits_releasedinteger required
source'api' | 'dashboard' required
api_key_idstring uuid nullable required
created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable required
queued_msinteger nullable
duration_msinteger nullable
total_msinteger nullable
result_expiredboolean

Changes

No recorded changes to this operation across all 1 revision of this API.