Skip to content

Additional

additional

Scrape.do Async-API Additional Plugin Adapters

Current Async-Only Plugins
Usage

These adapters participate in the AsyncPlugin discriminated union consumed by JobCreationRequest.plugin

No Sync Gateway

  • None of these plugins has a dedicated synchronous gateway endpoint, which is why they're not listed in the Sync Plugins Sub-Package

  • Their parameter models live alongside their adapters here

Output Format

  • Walmart, Lowes, and Shein return raw HTML rather than structured JSON

  • Trip.com plugins return structured JSON

Official Documentation

Scrape.do's Async API Plugins page formally documents the full parameter schema for every plugin in this module

TripCabinClassType = Literal['Y', 'S', 'C', 'F'] module-attribute

Cabin class for trip/search

Mapping
  • Y = Economy
  • S = Premium Economy
  • C = Business
  • F = First

WalmartStoreParameters

Bases: BaseModel

Parameters accepted by the walmart/store plugin

Conditional Pair

  • zipcode and storeid are a conditional pair, both must be set or both must be omitted

  • When both are omitted, Scrape.do selects a random Walmart store for the request

  • Setting only one raises ValueError

Attributes:

Name Type Description
url str

Walmart product / category URL. Must point to the walmart.com domain
zipcode Optional[str]

U.S. zipcode (digits-only). Pairs with storeid
storeid Optional[int]

Walmart store ID. Pairs with zipcode
disableretry Optional[bool]

Skip Scrape.do's internal retry loop on transient failures
transparentresponse Optional[bool]

Return the target's actual status code instead of wrapping non-2xx in a 502
timeout Optional[int]

Per-target timeout in milliseconds (5000-120000)
Example 
from scrape_do.async_api.models.plugins import WalmartStoreParameters

param = WalmartStoreParameters(
    url="https://www.walmart.com/ip/123456",
    zipcode="72712",
    storeid=100,
    )

LowesStoreParameters

Bases: BaseModel

Parameters accepted by the lowes/store plugin

Attributes:

Name Type Description
url str

Lowes product / store URL. Must point to the lowes.com domain
zipcode str

U.S. zipcode (digits-only)
storeid str

Lowes store ID (digits-only)
disableretry Optional[bool]

Skip Scrape.do's internal retry loop on transient failures
transparentresponse Optional[bool]

Return the target's actual status code instead of wrapping non-2xx in a 502
timeout Optional[int]

Per-target timeout in milliseconds (5000-120000)
Example 
from scrape_do.async_api.models.plugins import LowesStoreParameters

param = LowesStoreParameters(
    url="https://www.lowes.com/pd/item/123",
    zipcode="28202",
    storeid="0595",
    )

WalmartStoreAsyncPlugin

Bases: BaseModel

Async adapter for the walmart/store plugin

Attributes:

Name Type Description
key Literal['walmart/store']

Plugin discriminator
params List[WalmartStoreParameters]

Per-job task entries (1-1000)

LowesStoreAsyncPlugin

Bases: BaseModel

Async adapter for the lowes/store plugin

Attributes:

Name Type Description
key Literal['lowes/store']

Plugin discriminator
params List[LowesStoreParameters]

Per-job task entries (1-1000)

SheinParameters

Bases: BaseModel

Parameters accepted by the shein plugin

URL Domain

  • url must point to the shein.com domain

  • Setting a non-Shein URL raises ValueError

Attributes:

Name Type Description
url str

Shein product / category URL
timeout Optional[int]

Per-target timeout in milliseconds (5000-120000)

SheinAsyncPlugin

Bases: BaseModel

Async adapter for the shein plugin

Attributes:

Name Type Description
key Literal['shein']

Plugin discriminator
params List[SheinParameters]

Per-job task entries (1-1000)

TripSearchParameters

Bases: BaseModel

Parameters accepted by the trip/search plugin

country

  • Lowercase ISO-3166-1 alpha-2 country code

  • Required at the plugin level OR via the top-level GeoCode field on the JobCreationRequest

Attributes:

Name Type Description
departCity str

Origin IATA code (3-char uppercase)
arriveCity str

Destination IATA code (3-char uppercase)
departDate str

Outbound date in YYYY-MM-DD format
country str

Lowercase ISO-3166-1 alpha-2 country code
returnDate Optional[str]

Return date for round trips (YYYY-MM-DD)
departAirport Optional[str]

Specific departure airport IATA
arriveAirport Optional[str]

Specific arrival airport IATA
adults Optional[int]

Number of adult passengers
children Optional[int]

Number of child passengers
infants Optional[int]

Number of infant passengers
cabinClass Optional[TripCabinClassType]

Cabin class
currency Optional[str]

ISO-4217 currency code
sortBy Optional[str]

Sort order for results

TripDetailParameters

Bases: BaseModel

Parameters accepted by the trip/detail plugin

Driver

  • policyId, shortPolicyId, and country are all required together

  • Both policyId and shortPolicyId come from a prior trip/search response and must be passed unchanged

Attributes:

Name Type Description
policyId str

Long-form policy identifier from a prior trip/search response
shortPolicyId str

Short-form policy identifier from the same trip/search response
country str

Lowercase ISO-3166-1 alpha-2 country code
productId Optional[str]

Specific product identifier
currency Optional[str]

ISO-4217 currency code
adults Optional[int]

Number of adult passengers
children Optional[int]

Number of child passengers
infants Optional[int]

Number of infant passengers

TripSearchAsyncPlugin

Bases: BaseModel

Async adapter for the trip/search plugin

Attributes:

Name Type Description
key Literal['trip/search']

Plugin discriminator
params List[TripSearchParameters]

Per-job task entries (1-1000)

TripDetailAsyncPlugin

Bases: BaseModel

Async adapter for the trip/detail plugin

Attributes:

Name Type Description
key Literal['trip/detail']

Plugin discriminator
params List[TripDetailParameters]

Per-job task entries (1-1000)