Docs · methods

Tracked accounts

The social profiles a project scrapes. The account url stored here is the exact key the social read methods take; rebuilding it from a handle will not match.

list_tracked_accounts · set_linkedin_handle · set_x_handle · set_instagram_handle

01

List tracked social accounts

list_tracked_accountsread

The accounts scraped for a project, with the url exactly as stored. A null lastPortedAt means the scraper has never run for that account yet.

Parameters2

  • projectIdintegerRequiredProject id from list_projects. Every scoped method needs it.
  • platformenumOptionallinkedin, x or instagram. Omit for all platforms.

Returns2

  • projectNamestring
  • accounts[]accountid, platform, url, displayName, lastPortedAt.
02

Track a LinkedIn account

set_linkedin_handlewrite

Start scraping a LinkedIn profile for a project. Accepts linkedin.com/company/acme or a bare handle. A url from another platform is rejected with platform_mismatch. The returned account url is the exact value get_linkedin_posts expects. Posts take a few minutes to appear after the first scrape.

Parameters2

  • projectIdintegerRequiredProject id from list_projects. Every scoped method needs it.
  • handlestringRequiredA profile url or bare handle, e.g. linkedin.com/company/acme or a bare handle.

Returns4

  • accountaccountid, platform, url, displayName, lastPortedAt. The url is what the read methods take.
  • previousUrlstring | nullAn account already tracked on this platform, if any. Both stay tracked.
  • scrapeQueuedbooleanWhether a scrape was actually dispatched.
  • alreadyTrackedboolean
03

Track an X (Twitter) account

set_x_handlewrite

Start scraping a X (Twitter) profile for a project. Accepts x.com/acme, twitter.com/acme or @acme. A url from another platform is rejected with platform_mismatch. The returned account url is the exact value get_twitter_posts expects. Posts take a few minutes to appear after the first scrape.

Parameters2

  • projectIdintegerRequiredProject id from list_projects. Every scoped method needs it.
  • handlestringRequiredA profile url or bare handle, e.g. x.com/acme, twitter.com/acme or @acme.

Returns4

  • accountaccountid, platform, url, displayName, lastPortedAt. The url is what the read methods take.
  • previousUrlstring | nullAn account already tracked on this platform, if any. Both stay tracked.
  • scrapeQueuedbooleanWhether a scrape was actually dispatched.
  • alreadyTrackedboolean
04

Track a Instagram account

set_instagram_handlewrite

Start scraping a Instagram profile for a project. Accepts instagram.com/acme or @acme. A url from another platform is rejected with platform_mismatch. The returned account url is the exact value get_instagram_posts expects. Posts take a few minutes to appear after the first scrape.

Parameters2

  • projectIdintegerRequiredProject id from list_projects. Every scoped method needs it.
  • handlestringRequiredA profile url or bare handle, e.g. instagram.com/acme or @acme.

Returns4

  • accountaccountid, platform, url, displayName, lastPortedAt. The url is what the read methods take.
  • previousUrlstring | nullAn account already tracked on this platform, if any. Both stay tracked.
  • scrapeQueuedbooleanWhether a scrape was actually dispatched.
  • alreadyTrackedboolean
← CompetitorsNews →