PhoenixNews

https://docs.phoenixnews.io/
Admin
PhoenixNews is an actionable news trading terminal that gathers real-time news from over 1500...
Tokens:3,828
Snippets:19
Trust Score:4.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example News Message Format (JSON)

Source: https://docs.phoenixnews.io/websocket/message-format/news

This JSON object illustrates the structure of a news message received from the PhoenixNews websocket. It includes fields such as source, sourceName, category, receivedAt, createdAt, url, title, noticeId, important, sub, and suggestions. This format is used for real-time news updates.

```JSON
{
  "source": "Terminal",
  "sourceName": "TERMINAL",
  "category": "SEC FILINGS",
  "receivedAt": "2024-12-02T11:02:01.084Z",
  "createdAt": "2024-12-02T11:02:01.084Z",
  "url": "https://www.sec.gov/Archives/edgar/data/2046791/000121465924019800/0001214659-24-019800-index.htm",
  "title": "WISDOMTREE FILES S-1 FOR XRP ETF",
  "noticeId": "076409c9f8F",
  "important": true,
  "sub": true,
  "suggestions": []
}
```

--------------------------------

### Mint PhoenixNFT using Etherscan Write Contract

Source: https://docs.phoenixnews.io/phoenixnft

This snippet outlines the manual steps to mint a PhoenixNFT by directly interacting with the smart contract's 'mintWhitelist' function on Etherscan. It involves connecting a Web3 wallet, navigating to the contract's write function, setting the payable amount, and confirming the transaction.

```APIDOC
Etherscan Contract Interaction:
  Contract Address: 0xb93ed6b544aa8d244c65d915c427139be4eb55b4
  Function: mintWhitelist
    Description: Initiates the NFT minting process for whitelisted users.
    Parameters:
      payableAmount:
        Type: Ether (ETH)
        Value: 3.5
        Description: The amount of Ether to send with the transaction for minting.
    Steps:
      1. Navigate to Etherscan contract write page.
      2. Connect Web3 wallet.
      3. Locate and expand "4. mintWhitelist" function.
      4. Input "3.5" into the "payableAmount" field.
      5. Click "Write" to initiate the transaction.
      6. Confirm transaction in connected wallet (e.g., MetaMask).
```

--------------------------------

### Open Short Position via Terminal Command

Source: https://docs.phoenixnews.io/terminal/command

This section explains how to open a short trading position for a cryptocurrency token using the PhoenixNews terminal's command feature. Similar to long positions, you can use default sizing or specify a custom amount. All command inputs are case-insensitive.

```Command Line
<S ETH>
```

```Command Line
<S ETH 50k>
```

```Command Line
<S 50k ETH>
```

--------------------------------

### Configure Order Value Multiplier for Terminal Commands

Source: https://docs.phoenixnews.io/terminal/command

Discover how to enable an 'Order value x1000' setting in the PhoenixNews terminal, specifically for Binance. This option automatically multiplies the input value by 1000, allowing users to omit the 'K' suffix for larger orders, streamlining the command input process.

```Command Line
<ETH 100>
```

--------------------------------

### Open Long Position via Terminal Command

Source: https://docs.phoenixnews.io/terminal/command

Learn how to initiate a long trading position for a specific cryptocurrency token using the PhoenixNews terminal's command input. This feature supports both default sizing, configured previously, and custom position sizing by appending the desired amount. Command inputs are not case-sensitive.

```Command Line
<ETH>
```

```Command Line
<L ETH>
```

```Command Line
<ETH 50k>
```

```Command Line
<L ETH 50k>
```

```Command Line
<L 50k ETH>
```

```Command Line
<50k ETH>
```

--------------------------------

### Field Descriptions for Twitter User Object Schema

Source: https://docs.phoenixnews.io/websocket/message-format/tweets/follow-updates

Provides detailed descriptions for each field within the `twitterFollowed` or `twitterUnfollowed` sub-objects, including their data types and purpose.

```APIDOC
Field: bio
  Type: String
  Description: Bio of the user.
Field: profileImage
  Type: String
  Description: Twitter profile image URL.
Field: banner
  Type: String
  Description: Twitter banner image URL.
Field: followers
  Type: Number
  Description: Follower count of the user.
Field: following
  Type: Number
  Description: Number of accounts the user follows.
Field: postsCount
  Type: Number
  Description: Number of posts/tweets.
Field: location
  Type: String
  Description: Location in the user’s Twitter profile
Field: profileUrl
  Type: String
  Description: Website or external link listed in the user’s Twitter profile
Field: profileCreatedAt
  Type: String
  Description: Account creation date.
Field: username
  Type: String
  Description: Twitter handle (without @).
Field: name
  Type: String
  Description: Display name.
Field: twitterId
  Type: String
  Description: Unique Twitter ID of the user.
Field: url
  Type: String
  Description: URL to their Twitter profile.
```

--------------------------------

### PhoenixNews WebSocket Authentication Methods

Source: https://docs.phoenixnews.io/websocket/authentication

Describes the WebSocket endpoint and the two available methods for authenticating with the PhoenixNews WebSocket using an API key: sending a 'login apiKey' message or including the API key in the 'x-api-key' header.

```APIDOC
WebSocket Endpoint:
  wss://wss.phoenixnews.io

Authentication Methods:
1. Message-based Authentication:
   Send the following message to the WebSocket connection:
   "login apiKey"

2. Header-based Authentication:
   Include your apiKey in the "x-api-key" header when establishing the WebSocket connection.
```

--------------------------------

### Authenticate PhoenixNews WebSocket

Source: https://docs.phoenixnews.io/websocket

Details the methods for authenticating with the PhoenixNews WebSocket. Users can send their API key either as a 'login' message or by including it in the 'x-api-key' header during connection establishment. The API key can be retrieved from the user's account page.

```APIDOC
WebSocket Endpoint: wss://wss.phoenixnews.io

API Key Retrieval:
  Obtain your API key from: https://phoenixnews.io/ → Account → Copy ApiKey

Authentication Methods:
1. Message-based Authentication:
   Send the following string as a message to the WebSocket:
   "login <your_api_key>"

2. Header-based Authentication:
   Include your API key in the "x-api-key" header when establishing the WebSocket connection.
   Header: "x-api-key: <your_api_key>"
```

--------------------------------

### Schema for Twitter Followed/Unfollowed User Object

Source: https://docs.phoenixnews.io/websocket/message-format/tweets/follow-updates

Defines the structure and data types for the `twitterFollowed` or `twitterUnfollowed` sub-objects, which contain metadata about a Twitter user.

```APIDOC
{
  "bio": String,
  "profileImage": String,
  "banner": String,
  "followers": Number,
  "following": Number,
  "postsCount": Number,
  "location": String,
  "profileUrl": String,
  "profileCreatedAt": String,
  "username": String,
  "name": String,
  "twitterId": String,
  "url": String
}
```

--------------------------------

### Receive AI News Summary Message Format via WebSocket

Source: https://docs.phoenixnews.io/websocket/ai-news-summary

This JSON object defines the message format for AI-generated news summaries received through the WebSocket. It includes unique identifiers for the original news or tweet, a timestamp, the message type indicating an AI summary, and the actual AI-generated summary text.

```JSON
{
  "_id": "6682c4aea633a002535d8c20",
  "noticeId": "302876",
  "time": 1719846063656,
  "type": "summary-ai",
  "summaryAI": "Metaplanet buys 20.195 BTC for $1.2M, increasing holdings to $10.1M, amid Japan's economic pressures"
}
```

--------------------------------

### Twitter Follow/Unfollow Event Message Format

Source: https://docs.phoenixnews.io/websocket/message-format/tweets/follow-updates

This API documentation describes the JSON object structure for real-time Twitter follow and unfollow events received via the PhoenixNews websocket. It includes details on each field's type, purpose, and conditions for presence.

```APIDOC
Object Structure:
{
  "body": String,
  "receivedAt": String,
  "createdAt": String,
  "source": String,
  "username": String,
  "name": String,
  "url": String,
  "icon": String,
  "isFollowUpdate": Boolean,
  "twitterId": String,
  "tweetId": String,
  "twitterFollowed": Object,          // Present if follow event
  "twitterUnfollowed": Object,        // Present if unfollow event
  "_id": String,
}

Field Descriptions:
- body: String
  Summary of the event. Includes the action and usernames.
- receivedAt: String
  Timestamp when the event was received by the system.
- source: String
  Always "Twitter" for these events.
- username: String
  Twitter username (without @) of the user who performed the action.
- name: String
  Display name of the acting user.
- url: String
  URL to the acting user's Twitter profile.
- icon: String
  Profile picture of the acting user.
- isFollowUpdate: Boolean
  Always true. Indicates this message refers to a follow/unfollow event.
- twitterId: String
  Twitter ID of the user who performed the action.
- tweetId: String
  Internal ID associated with the event. Not a real Tweet ID.
- twitterFollowed: Object
  Full profile metadata of the followed user. Present only on follow events.
- twitterUnfollowed: Object
  Full profile metadata of the unfollowed user. Present only on unfollow events.
- _id: String
  Unique internal ID for the event.
```

--------------------------------

### Tweet Object Field Descriptions

Source: https://docs.phoenixnews.io/websocket/message-format/tweets

Provides detailed descriptions for each field within the tweet object, including data types and explanations of their content and purpose.

```APIDOC
Field: _id
Type: String
Description: Unique document ID.

Field: receivedAt
Type: String
Description: ISO timestamp when the tweet was received by the system.

Field: createdAt
Type: String
Description: ISO timestamp when the tweet was created.

Field: source
Type: String
Description: Source (e.g., "Twitter").

Field: username
Type: String
Description: Twitter handle (without @).

Field: name
Type: String
Description: Display name of the Twitter account.

Field: body
Type: String
Description: Full tweet content, including quotes or retweets if present.

Field: text
Type: String
Description: Clean tweet text without quotes or retweets.

Field: url
Type: String
Description: Direct URL to the tweet.

Field: followers
Type: Number
Description: Number of followers the author has.

Field: banner
Type: String
Description: URL of the account's banner image.

Field: icon
Type: String
Description: URL of the account's avatar.

Field: urls
Type: Array of Objects
Description: List of URLs mentioned in the tweet. Each object has:
  • url: full URL
  • displayUrl: shortened version.

Field: images
Type: Array of Objects
Description: List of media items attached to the tweet. Each item includes:
  • type: the media type, which can be "photo", "video", or "animated_gif"
  • url: the URL of the corresponding media item.

Field: tweetId
Type: String
Description: Unique ID of the tweet.

Field: twitterId
Type: String
Description: Twitter user ID of the tweet author.

Field: isRetweet
Type: Boolean
Description: Whether this tweet is a retweet.

Field: isQuote
Type: Boolean
Description: Whether this tweet quotes another tweet.

Field: isReply
Type: Boolean
Description: Whether this tweet is a reply.

Field: isSelfReply
Type: Boolean
Description: Whether this is a reply to the user's own tweet.

Field: coin
Type: String
Description: Associated crypto symbol, if any.

Field: quote
Type: Object
Description: Quote tweet info

Field: reply
Type: Object
Description: Replied-to tweet info

Field: retweet
Type: Object
Description: Retweet info
```

--------------------------------

### Twitter Profile Update Event Message Structure

Source: https://docs.phoenixnews.io/websocket/message-format/tweets

Illustrates the partial JSON structure for a message indicating a profile update event. This flag is typically part of a larger message payload.

```APIDOC
{
    ...,
    isProfileUpdate: true
}
```

--------------------------------

### WebSocket Message Format for Important Auto

Source: https://docs.phoenixnews.io/websocket/important-auto

Defines the structure of the WebSocket message sent when the 'Important Auto' feature detects and highlights news. It includes a unique ID, notice ID, timestamp, type, and an 'importantAuto' flag.

```json
{
  "_id": "67557d0374b91122ef77c7c9", //The same as the original news
  "noticeId": "302876", // or tweetId
  "time": 1734042346123,
  "type": "important-auto",
  "importantAuto": true
}
```

--------------------------------

### Twitter Quote/Retweet/Reply Object API Definition

Source: https://docs.phoenixnews.io/websocket/message-format/tweets

Defines the JSON structure for `quote`, `retweet`, and `reply` sub-objects, including all their properties, types, and detailed descriptions. This object represents a specific tweet-like entity within the Twitter data stream.

```APIDOC
{
  "twitterId": String,
  "tweetId": String,
  "text": String,
  "username": String,
  "name": String,
  "followers": Number,
  "banner": String,
  "icon": String,
  "url": String,
  "createdAt": String,
  "urls": [
    {
      "url": String,
      "displayUrl": String
    }
  ],
  "images": [
    {
      "type": String,
      "url": String
    }
  ]
}

Field Descriptions:
- twitterId: String - Unique identifier of the user who posted the quote/reply/retweet.
- tweetId: String - Unique identifier of the quote/reply/retweet itself.
- text: String - Text content of the quote/reply/retweet.
- username: String - Twitter handle (without @) of the user who posted the quote/reply/retweet.
- name: String - Display name of the user who posted the quote/reply/retweet.
- followers: Number - Number of followers the user who posted the quote/reply/retweet has.
- banner: String - URL to the banner image of the user’s profile who posted the quote/reply/retweet.
- icon: String - URL to the profile picture (icon) of the user who posted the quote/reply/retweet.
- url: String - URL linking directly to the quote/reply/retweet.
- createdAt: String - Timestamp when the quote/reply/retweet was created (ISO format).
- urls: Array of Objects - List of URLs mentioned in the quote/reply/retweet. Each object has:
    - url: full URL
    - displayUrl: shortened version.
- images: Array of Objects - List of media items attached to the quote/reply/retweet. Each item includes:
    - type: the media type, which can be "photo", "video", or "animated_gif"
    - url: the URL of the corresponding media item.
```

--------------------------------

### Twitter Article Event Message Structure

Source: https://docs.phoenixnews.io/websocket/message-format/tweets

Illustrates the partial JSON structure for a message indicating an article event. This flag is typically part of a larger message payload.

```APIDOC
{
    isArticle: true
}
```

--------------------------------

### Twitter Pinned Tweet Event Message Structure

Source: https://docs.phoenixnews.io/websocket/message-format/tweets

Illustrates the partial JSON structure for a message indicating a tweet has been pinned. It includes the ID of the pinned tweet and is typically part of a larger message payload.

```APIDOC
{
    ...,
    isTweetPinned: true,
    tweetPinnedId: "1823742501884453312"
}
```

--------------------------------

### Tweet Object Structure

Source: https://docs.phoenixnews.io/websocket/message-format/tweets

Defines the JSON structure for a tweet object received via the PhoenixNews websocket, including nested objects for URLs, images, quotes, replies, and retweets.

```JSON
{
  "_id": String,
  "receivedAt": String,
  "createdAt": String,
  "source": String,
  "username": String,
  "name": String,
  "body": String,
  "text": String,
  "url": String,
  "followers": Number,
  "banner": String,
  "icon": String,
  "urls": [
    {
      "url": String,
      "displayUrl": String
    }
  ],
  "images": [
    {
      "type": String,
      "url": String
    }
  ],
  "tweetId": String,
  "twitterId": String,
  "isRetweet": Boolean,
  "isQuote": Boolean,
  "isReply": Boolean,
  "isSelfReply": Boolean,
  "coin": String,
  "quote": Object,
  "reply": Object,
  "retweet": Object
}
```

--------------------------------

### Twitter Deleted Tweet Event Message Structure

Source: https://docs.phoenixnews.io/websocket/message-format/tweets

Illustrates the partial JSON structure for a message indicating a tweet has been deleted. It includes the ID of the deleted tweet and is typically part of a larger message payload.

```APIDOC
{
    ...,
    isTweetDeleted: true,
    tweetDeletedId: "1823742501884453312"
}
```
Tokens:
Raw