GET/v1/crawlers/{crawler_hash}/params

Get Crawler Parameters

Retrieve the list of configurable input parameters for a specific crawler

This endpoint returns all configurable input parameters for a specific crawler. The response is organized into two main sections: task and squid.

Response Structure

The response contains:

task: Object containing task-level parameters (parameter name as key)
squid: Object containing squid-level parameters and functions
squid.functions: Optional add-on features with extra credit costs

Task-level Parameter Fields

task.{parameter_name}.type

string

Data type (string, int, boolean, etc.)

Example: string

task.{parameter_name}.group

string

Logical grouping (e.g., "url", "location")

Example: url

task.{parameter_name}.regex

string

Validation pattern for string inputs

Example: ^https?://.*

task.{parameter_name}.required

boolean

Whether the parameter is mandatory

Example: true

task.{parameter_name}.default

stringnumberbooleannull

Default value if not provided

Example: null

task.{parameter_name}.attribute

string

Internal attribute name

Example: url

task.{parameter_name}.is_params

boolean

Whether it's used for URL parameter generation

Example: true

Squid-level Parameter Fields

squid.{parameter_name}.type

string

Data type of the parameter

Example: string

squid.{parameter_name}.allowed

array

Array of valid values (for enum types)

Example: [en, es, fr]

squid.{parameter_name}.default

stringnumberbooleannull

Default value if not provided

Example: en

squid.{parameter_name}.required

boolean

Whether the parameter is mandatory

Example: false

squid.{parameter_name}.attribute

string

Internal attribute name

Example: language

Functions (Optional Add-ons) Fields

squid.functions.{function_name}.sort

integer

Display order of the function

Example: 1

squid.functions.{function_name}.default

boolean

Whether the function is enabled by default

Example: false

squid.functions.{function_name}.credits_per_function

number

Extra credits charged per row when this function is enabled

Example: 0.5

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	No

Parameters

crawler_hashstring

Required

The unique identifier (hash/id) of the crawler

Example: 4734d096159ef05210e0e1677e8be823

Pro Tip

The response structure uses parameter names as object keys. Access task parameters via params.task.url, squid parameters via params.squid.language, etc.

Note

Functions under squid.functions are optional add-ons. Each function has a credits_per_function cost applied per result row when enabled.

Warning

Pay attention to 'allowed' arrays in squid parameters - these only accept specific values. Sending invalid values will cause validation errors.

Pro Tip

Use 'regex' patterns in task parameters to validate input before sending. This helps catch errors early and reduces failed tasks.

Pro Tip

Parameters with 'group' field are logically related. For location-based crawlers, you'll typically need to provide all parameters in the 'location' group.