The CrowdTangle API corresponds to several functions available through the Dashboard. It’s as if you were directly obtaining a CSV of your List or Saved Search, but in JSON or XML format.

Postman is a free API software. Click here to download a JSON file that you can import into Postman, and get a template for each endpoint.  

 

Some helpful tips for getting the best API experience:

  • For all endpoints, use the Start Date and End Date Parameters to prevent CrowdTangle from crashing and to reduce load times.
  • If you don’t specify the Sort parameter, the API will by default return Posts sorted by Overperforming. This will exclude Posts that are Underperforming. Make sure to sort by date or by Total Interactions to capture all Posts.
  • The API will stop returning posts at 10,000. Use the Start Date and End Date parameters to slice your query by date and prevent missed posts.
  • /Posts/Search is not enabled by default. We can enable it for you based on the use case -- just email your CrowdTangle point person, or support@crowdtangle.com
  • The API uses the UTC timezone. This cannot be changed. The CrowdTangle User Interface allows the user to change the time zone of their dashboard, so always account for time zone differences when comparing results in the API and UI.
  • Rate limits: 6 calls/min for all but Links, which is 2 calls/min. We can raise your rate limit depending on the use case.

 

Endpoints Overview

/Posts

  • This endpoint lets you stream data from Posts in a List or Saved Search. It’s as if you were looking at a List or Saved Search in your Dashboard.
  • You can search for terms within the List or Saved Search.
  • Make sure to grab your List ID from the URL in order to pull in Posts -- this ID exists for both Lists and Saved Searches.
  • You can use Weights just like in a List or Saved Search in the Dashboard, on a scale of 1-10
  • The default number of Posts returned at a time is 10. The Count parameter can only go to between 1-100.

 

/Posts/Search

  • This endpoint acts like Historical Data, but with more nuanced search terms. It lets you search the entire CT database, and will always pull in BOTH Pages/Profiles and Groups. There is no way to differentiate. 
  • You can pull in from Lists and Saved Search by filling the List ID parameter, just like in the /Posts endpoint. You can also pull in from Account using Account ID parameter
  • You can use “AND” and “NOT” for terms and Lists to search, but you cannot use Weights. 
  • Most of the functionality you’d want from this is easily available by setting up a Saved Search in your Dashboard, and pulling it in through the Posts endpoint.
  • The default number of Posts returned at a time is 10. Count can only go to between 1-100

 

/Leaderboard

  • This acts like Lists Leaderboard -- NOT Search Leaderboard. You will not get a list of the number of Posts that match your Search parameters through this endpoint.

 

/Links

  • This endpoint acts like the Chrome Extension.
  • You can specify the number of Posts to pull in - the maximum is 100. 
  • Set the Summary parameter to “true” to get the top-line summary of interactions for the link.
  • This will pull in Facebook, Instagram and Reddit, but not Twitter, even though Chrome Extension does. 

 

/Lists

  • This endpoint tells you the names of all your Lists

 

/Lists/:listId/accounts

  • This endpoint tells you the names of all the Pages in a given List.

 
For more information, please see this broader overview of the API, and check out our API documentation on github.

Did this answer your question?