API
X (Twitter) API
X reaches around 600 million monthly users through short posts, live commentary, video, and breaking-news conversation, making it important for real-time communications, media visibility, and reputation response.
API Reference Version: 1.0.0 38 Endpoints Authentication
Base URL
https://api.pressmonitor.ca Authentication
All requests use Bearer token authentication. Add the Authorization header to every call.
Authorization: Bearer YOUR_API_KEY
x-subscription-id: YOUR_SUB_ID GET
/autocomplete Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| value | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/autocomplete?value=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/comments Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| pid | string | query | Yes | Pid |
| ranking_mode | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/comments?pid=VALUE&ranking_mode=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/community-topics Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/community-topics" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/community-tweets Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| communityId | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/community-tweets?communityId=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/fetch-popular-communities Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| topicId | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/fetch-popular-communities?topicId=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/followers Followers
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/followers?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/followers-ids Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| username | string | query | Yes | Username (screen name without @ symbol, e.g., 'elonmusk') |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/followers-ids?username=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/followings Followings
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/followings?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/followings-ids Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| username | string | query | Yes | Username (screen name without @ symbol, e.g., 'elonmusk') |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/followings-ids?username=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/get-users Get Users
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| users | string | query | Yes | Users |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/get-users?users=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/group-tweets Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| communityId | string | query | Yes | |
| rankingMode | string | query | Yes | |
| searchType | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/group-tweets?communityId=VALUE&rankingMode=VALUE&searchType=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/highlights Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/highlights?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/jobs-details Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| jobId | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/jobs-details?jobId=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/jobs-locations-suggest Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| query | string | query | Yes | Search query |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/jobs-locations-suggest?query=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/jobs-search Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| employment_type | string | query | Yes | |
| job_location_id | string | query | Yes | |
| job_location_type | string | query | Yes | |
| keyword | string | query | Yes | |
| seniority_level | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/jobs-search?employment_type=VALUE&job_location_id=VALUE&job_location_type=VALUE&keyword=VALUE&seniority_level=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/likes Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| pid | string | query | Yes | Pid |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/likes?pid=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/list-details Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| listId | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/list-details?listId=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/list-timeline Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| listId | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/list-timeline?listId=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/list-tweets Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| list_id | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/list-tweets?list_id=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/org-affiliates Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/org-affiliates?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/quotes Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| pid | string | query | Yes | Pid |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/quotes?pid=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/retweets Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| pid | string | query | Yes | Pid |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/retweets?pid=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/search Search
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| query | string | query | Yes | Search query |
| type | string | query | Yes | Type |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/search?query=VALUE&type=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/search-community Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| query | string | query | Yes | Search query |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/search-community?query=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/search-lists Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| query | string | query | Yes | Search query |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/search-lists?query=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/searchold Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| query | string | query | Yes | Search query |
| type | string | query | Yes | Type |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/searchold?query=VALUE&type=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/spaces Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| id | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/spaces?id=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/trends Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| woeid | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/trends?woeid=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/trends-locations Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/trends-locations" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/tweet Tweet
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| pid | string | query | Yes | Pid |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/tweet?pid=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/tweet-by-ids Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tweetIDs | string | query | Yes | |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/tweet-by-ids?tweetIDs=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/user User
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| username | string | query | Yes | Username (screen name without @ symbol, e.g., 'elonmusk') |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/user?username=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/user-likes Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/user-likes?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/user-media Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| cusor | string | query | Yes | |
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/user-media?cusor=VALUE&user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/user-replies Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/user-replies?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/user-replies-v2 Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/user-replies-v2?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/user-tweets User Tweets
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/user-tweets?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success
GET
/verified-followers Verified Followers
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| user | string | query | Yes | Numeric User ID (not username). Use 'user' endpoint to lookup ID from username |
| count | integer | query | No | Number of results to return |
| cursor | integer | query | No | Pagination cursor for next page |
Code Examples
curl -X GET "https://api.pressmonitor.ca/verified-followers?user=VALUE" -H "Authorization: Bearer YOUR_API_KEY" -H "x-subscription-id: YOUR_SUB_ID" Responses
200 Success