Skip to content

Implentation of Twitter v. 2 API : Roadmap

Dolsy Smith edited this page Jul 6, 2022 · 2 revisions

07/06/22

This document provides an overview of changes in the Twitter v. 2 API/twarc2 and a roadmap for implementation in SFM.

Summary of changes

Authentication

  • Rate limits/monthly quotas, allowed endpoints, and allowed operators depend on the user's access level.
  • Users can either provide consumer key/secret or a bearer token. Bearer token may have some advantages.
  • Currently, no way to check the user's quota via API.

All types of harvest

  • Users can specify which types of expansions they prefer to receive. By default, twarc2 retrieves all available expansions.

Search

Stream (filter)

  • Number of matching rules limited by access level
  • Rules can contain complex queries -- it is recommended to construct a sufficiently targeted query in order to avoid running over quotas.
  • Multiple matching rules are applied to the same stream, as opposed to running one stream per query (as in version 1).

Timeline

Sample

  • Sample stream in v.1 will be turned off in October 2022.

Development Plan

Phase 1 (July-August, 2022)

  1. Implement support for the v.2 Search API to support users with Academic Research access (for historical search). This targets an important use case we currently aren't able to support on v.1.

  2. Implement support for the v. 2 Sample Stream API, since version 1 of this API will be deprecated in October 2022.

  3. Release a beta version on the SFM sandbox and invite users to help us test it before rolling it into production. This will be particularly useful, since the development team at GW does not have Academic Research access credentials.

Phase 2

  1. Implement support for the v.2 Timeline API.

  2. Implement support for the v.2 Streaming API.