Spiderlook
Get started

Spiderlook API 1.0.0

API reference

Pre-rendered from the live OpenAPI document. For authentication, tokens, and scopes, see the API docs.

API docs by Redocly

Spiderlook API (1.0.0)

Download OpenAPI specification: https://api.spiderlook.com/v1/openapi.json

Public Spiderlook API for competitive intelligence: organizations, tracked companies, ads, social posts, website changes, and battlecards.

public-v1

Current organization

Authorizations:
HTTPBearer
path Parameters
slug
required
string (Slug)

Responses

Response samples

Content type
application/json
{ }

List tracked companies

Cursor pagination for tracked companies (your brand, rivals, benchmarks).

Cursor format: base64(JSON) with keys {after_created_at, after_id}.

Authorizations:
HTTPBearer
path Parameters
slug
required
string (Slug)
query Parameters
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Cursor (string) or Cursor (null) (Cursor)
Since (string) or Since (null) (Since)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_cursor": "string",
  • "limit": 0
}

List ads

List Meta and Google ads for tracked companies in the organization.

Authorizations:
HTTPBearer
path Parameters
slug
required
string (Slug)
query Parameters
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Cursor (string) or Cursor (null) (Cursor)
Since (string) or Since (null) (Since)
Updated Since (string) or Updated Since (null) (Updated Since)
Tracked Company (string) or Tracked Company (null) (Tracked Company)
Platform (string) or Platform (null) (Platform)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_cursor": "string",
  • "limit": 0
}

List social posts

List social posts across Instagram, TikTok, Facebook, LinkedIn, YouTube, and X.

Authorizations:
HTTPBearer
path Parameters
slug
required
string (Slug)
query Parameters
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Cursor (string) or Cursor (null) (Cursor)
Since (string) or Since (null) (Since)
Tracked Company (string) or Tracked Company (null) (Tracked Company)
Network (string) or Network (null) (Network)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_cursor": "string",
  • "limit": 0
}

List website changes

List watched website page updates for tracked companies.

Authorizations:
HTTPBearer
path Parameters
slug
required
string (Slug)
query Parameters
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Cursor (string) or Cursor (null) (Cursor)
Since (string) or Since (null) (Since)
Tracked Company (string) or Tracked Company (null) (Tracked Company)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_cursor": "string",
  • "limit": 0
}

List battlecards

List battlecards for tracked companies in the organization.

Authorizations:
HTTPBearer
path Parameters
slug
required
string (Slug)
query Parameters
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Cursor (string) or Cursor (null) (Cursor)
Since (string) or Since (null) (Since)
Tracked Company (string) or Tracked Company (null) (Tracked Company)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_cursor": "string",
  • "limit": 0
}

Get a battlecard

Authorizations:
HTTPBearer
path Parameters
slug
required
string (Slug)
battlecard_id
required
string (Battlecard Id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tracked_company": {
    },
  • "content": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "approved_at": "2019-08-24T14:15:22Z"
}