GET/v1/crawlers/{crawler_hash}/attributes

Get Crawler Attributes

Retrieve the list of output attributes (result fields) for a specific crawler

This endpoint returns all output attributes (result fields) for a specific crawler. Each attribute describes a field that may appear in your scraping results, along with its data type, an example value, and the function it belongs to.

This is useful for understanding the shape of data a crawler produces before you start scraping, or for building dynamic result parsers.

Attribute Fields

name

string

The field name as it appears in result objects

Example: name

type

string

Data type of the field (string, integer, float, boolean, text, json)

Example: string

example

any

Example value for the field. May be null for optional fields

Example: Blues Billard Club

function

string

The crawler function this attribute belongs to

Example: Export Local Businesses

is_main

boolean

Whether this attribute is included by default (true) or requires enabling a function (false)

Example: true

description

string

Human-readable description of what this field contains

Example: Business name as listed on Google Maps

Main vs Function Attributes

Attributes are divided into two categories:

Main attributes (is_main: true): Always included in results by default.
Function attributes (is_main: false): Only included when their parent function is enabled on your squid (e.g., "Collect Business Details", "Extract Emails from Website").

Headers

Key	Value	Required
Content-Type	application/json	No

Parameters

crawler_hashstring

Required

The unique identifier (hash/id) of the crawler

Example: 4734d096159ef05210e0e1677e8be823

Pro Tip

This is a public endpoint — no authentication is required.

Note

Attributes with is_main: false only appear in results when their parent function is enabled on your squid. Check the function field to see which add-on controls each attribute.

Pro Tip

Use the type field to build typed parsers for your results. Supported types are: string, integer, float, boolean, text (long string), and json (structured data).

Pro Tip

Combine this endpoint with Get Crawler Parameters to fully understand both the inputs and outputs of any crawler before integrating it.