Skip to main content
POST
Create Audience List

Authorizations

Authorization
string
header
required

Enter your API key: wave_live_<token>

Body

application/json

Payload to create an audience list and start background scraping.

name
string
required

User-friendly name for this audience list

Required string length: 1 - 150
Example:

"SaaS Founders & Agency Owners"

type
enum<string>
required

Audience source type. Public API supports FOLLOWERS, POSTS, KEYWORDS, MENTIONS (MANUAL/FOLLOWINGS/HASHTAGS excluded).

Available options:
FOLLOWERS,
POSTS,
KEYWORDS,
MENTIONS
Example:

"FOLLOWERS"

desc
string | null

Optional description or notes for the audience list

Example:

"Scraped followers of @gohighlevel and @hubspot"

max_scrape_count
integer | null
default:500

Maximum number of leads to extract (must be between 500 and 2,500)

Required range: 500 <= x <= 2500
Example:

1000

parentUsernames
string[] | null

Target Instagram usernames to extract leads from. Required for FOLLOWERS (exactly 1), KEYWORDS (1-5), MENTIONS (1-5).

Example:

Parent Instagram post or reel URLs. Required when type=POSTS — at least one of likes or comments must be true on each link.

filters
FilterConfigSchema · object[] | null

List of filter criteria to apply to the scraped audience

Response

Successful Response

Full detail of an audience list including filter configurations.

id
string<uuid>
required

Audience list ID

name
string
required
type
string
required
desc
string | null
max_scrape_count
integer | null
parentUsernames
string[] | null

Parent Instagram post or reel URLs used to seed a POSTS audience (with like/comment filters)

raw_audience
integer
default:0

Total raw leads extracted from Instagram

filtered_audience
integer
default:0

Total leads that passed the filter criteria

filters
FilterConfigSchema · object[]

Configured filter rules

created_at
string<date-time> | null
updated_at
string<date-time> | null