actors

Run an actor (auto or manual proxy mode; async, or wait for the result directly)

post/v1/actors/{slug}/runs

Request

  • Base URL: https://barchin.net/api
  • URL: https://barchin.net/api/v1/actors/{slug}/runs
  • Auth: HTTP bearer

Path parameters

slugstring required

Query parameters

waitinteger

0 = async, returns run_id. >0 = wait up to this many seconds for the result. ۰ = async و برگرداندن run_id؛ >۰ = تا این ثانیه منتظر نتیجه بمان (سقف سرور: SYNC_MAX_WAIT_SECONDS). اگر در این مدت تمام نشد، ۲۰۲ با run_id برمی‌گردد و اجرا ادامه دارد؛ آن را با status_url دنبال کنید.

mode'auto' | 'manual'

auto (default): start from the cheapest proxy and escalate only if needed; manual: use exactly the pool named in proxy. auto (پیش‌فرض): از ارزان‌ترین پروکسی ممکن شروع و در صورت نیاز ارتقا می‌دهیم. manual: فقط نوعی که در proxy مشخص می‌کنید.

proxy'datacenter' | 'residential' | 'unblocker'

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

Proxy pool: datacenter | residential | unblocker. Only meaningful with mode=manual; defaults to residential if omitted. Cannot exceed this actor's max_tier. نوع پروکسی: datacenter | residential | unblocker. فقط در mode=manual معنا دارد؛ اگر نفرستید residential استفاده می‌شود. بالاتر از max_tier همین اکتور مجاز نیست.

countrystring nullable

Two-letter country code the exit IP should be from (e.g. ir). Default: worldwide. کد دو حرفی کشوری که IP خروجی باید از آن باشد (مثل ir). پیش‌فرض: جهانی. سایت‌هایی که فقط به کاربران کشور خودشان سرویس می‌دهند IP خارجی را رد می‌کنند. روی پروکسی دیتاسنتر اثری ندارد.

Example:ir

Request body

urlstring nullable

Example request

{
  "url": "https://torob.com/p/16080a39-171a-4b75-8b76-fcd95e26983e/"
}

Response

نتیجه‌ی آماده (حالت wait)

run_idstring uuid required
actor_slugstring required
actor_titlestring nullable
countrystring nullable
status'queued' | 'processing' | 'succeeded' | 'failed' required
inputobject required
mode'auto' | 'manual' required
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.

base_creditsinteger required
page_budgetinteger required
pages_fetchedinteger nullable required
credits_per_pageinteger nullable required
credits_heldinteger required
credits_chargedinteger nullable required
credits_releasedinteger required
item_countinteger required
source'api' | 'dashboard' required
created_atstring date-time required
started_atstring date-time nullable required
finished_atstring date-time nullable required
queued_msinteger nullable
duration_msinteger nullable
total_msinteger nullable
queue_positioninteger nullable
eta_msinteger nullable
metaobject nullable
datasetobject[] nullable

Changes

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