{"id":18318702,"url":"https://github.com/xdevplatform/gnip-insights-interface","last_synced_at":"2026-03-15T21:54:40.684Z","repository":{"id":57435121,"uuid":"67547022","full_name":"xdevplatform/Gnip-Insights-Interface","owner":"xdevplatform","description":"Interface to Twitter's Engagement API","archived":false,"fork":false,"pushed_at":"2021-03-08T18:44:10.000Z","size":21,"stargazers_count":33,"open_issues_count":4,"forks_count":21,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-01-13T19:49:45.661Z","etag":null,"topics":["engagement-api","python","twitter"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xdevplatform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-06T21:08:50.000Z","updated_at":"2025-10-01T09:41:57.000Z","dependencies_parsed_at":"2022-09-14T05:11:39.140Z","dependency_job_id":null,"html_url":"https://github.com/xdevplatform/Gnip-Insights-Interface","commit_stats":null,"previous_names":["jeffakolb/gnip-insights-interface","xdevplatform/gnip-insights-interface"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/xdevplatform/Gnip-Insights-Interface","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2FGnip-Insights-Interface","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2FGnip-Insights-Interface/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2FGnip-Insights-Interface/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2FGnip-Insights-Interface/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xdevplatform","download_url":"https://codeload.github.com/xdevplatform/Gnip-Insights-Interface/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2FGnip-Insights-Interface/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30552179,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-15T15:03:43.933Z","status":"ssl_error","status_checked_at":"2026-03-15T15:03:37.630Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["engagement-api","python","twitter"],"created_at":"2024-11-05T18:11:18.103Z","updated_at":"2026-03-15T21:54:40.653Z","avatar_url":"https://github.com/xdevplatform.png","language":"Python","readme":"# Overview\n\nThis repository contains a Python package that provides an\ninterface to Twitter's\n[Engagement API](https://developer.twitter.com/en/docs/twitter-api/enterprise/engagement-api/overview).  \nIn addition to providing a straightforward interface to the API, this package \nimplements extra aggregation features. \n\n\n# Installation\n\nYou can pip-install the package:\n\n`$ pip install gnip_insights_interface`\n\nYou can also install a local version from the cloned repository location.\n\n`[REPOSITORY] $ pip install -e . -U`\n\n# Credentials\n\nThis package expects to find a YAML credentials file called \n`.twitter_api_creds` in your home directory. This files must\ncontain your [Twitter Oauth credentials](https://dev.twitter.com/oauth/3-legged)\nin the following format:\n\n```\nusername: YOUR_USER_NAME\nengagement:\n    consumer_key: --\n    consumer_secret: --\n    token: --\n    token_secret: --\n    url: https://data-api.twitter.com/insights/engagement\n```\n\n# Engagement API Interface\n\nWe provide an interface for passing a set of Tweet IDs to the Twitter\nEngagement API, which provides engagement data such as impressions, favorites,\nand replies.  A full list of the available engagement types, their names, and\nthe ways that they can be grouped is available in the [API\ndocumentation](https://developer.twitter.com/en/docs/twitter-api/enterprise/engagement-api/overview). \n\nWe construct the API interface in a python module called `engagement_api`,\nwhich is part of the `gnip_insights_interface` package.  We provide a script\nfor command-line interface called `tweet_engagements.py`.  The script provides\ndirect access the the three endpoint of the API: total counts (`-T`), 28 hour\nsummary (`-D`, for \"day\"), as well as an aggregating function (`-H`) which\ncombines the data from results over an arbitrary time range. See the help option.\n\nCustom groupings and engagements types are set with a YAML configuration file\nspecified with the `-c` option. See example config in the `example` \ndirectory in the repository.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdevplatform%2Fgnip-insights-interface","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxdevplatform%2Fgnip-insights-interface","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdevplatform%2Fgnip-insights-interface/lists"}