Skip to documentation
Browse documentation

Search Are.na

Search public Are.na channels and users by keyword, one page at a time. Block search isn't available.

Capability ID arena.search
Maximum runtime 15 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

limit integer optional

Maximum results per result family in the requested page. With type all, channels and users each return up to this many From 1 to 100. Default: `24`.

Example 3
page integer optional

Page number At least 1. Default: `1`.

Example 1
query string required

Keyword query to search public Are.na channels and users

Example architecture
type string optional

Result family to return: all (channels and users), channels or users. Block search isn't available. Allowed values: `all`, `channels`, `users`. Default: `all`.

Example channels
Available values allchannelsusers

Response

Successful output is returned in results[0].data.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

PathObserved typeExample
blocks array 0 items
channels array 1 items
channels array 1 items
page integer 1
per integer 3
profiles array 0 items
query string architecture
total integer 3
total_pages integer 2518
type string channels

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.