openapi: 3.0.3
info:
  title: CryptoNews Account Trending API
  description: REST API aggregating cryptocurrency news, Bitcoin sentiment analysis, and crypto market news from 50+ sources with filtering by currency and time range. Provides AI-powered sentiment analysis, delayed pricing for 600+ coins, whale transaction tracking, and historical data from December 2020.
  version: '1'
  contact:
    url: https://cryptonews-api.com/
  termsOfService: https://cryptonews-api.com/termsandconditions
servers:
- url: https://cryptonews-api.com/api/v1
  description: Production server
security:
- tokenAuth: []
tags:
- name: Trending
  description: Trending headlines and top mentions
paths:
  /trending-headlines:
    get:
      summary: Get Trending Headlines
      operationId: getTrendingHeadlines
      description: Retrieve trending cryptocurrency news headlines. Optionally filter by specific ticker symbol.
      tags:
      - Trending
      parameters:
      - name: ticker
        in: query
        description: Cryptocurrency ticker symbol to filter trending headlines by.
        schema:
          type: string
          example: BTC
      - name: page
        in: query
        description: Page number for pagination.
        schema:
          type: integer
          default: 1
          example: 1
      - name: token
        in: query
        required: true
        description: API authentication token.
        schema:
          type: string
      responses:
        '200':
          description: Successful response with trending headlines
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeadlinesResponse'
        '401':
          description: Unauthorized - invalid or missing token
        '429':
          description: Rate limit exceeded
  /top-mention:
    get:
      summary: Get Top Mentioned Tickers
      operationId: getTopMention
      description: Retrieve the most frequently mentioned cryptocurrency tickers over a specified date range.
      tags:
      - Trending
      parameters:
      - name: date
        in: query
        description: Date range for top mention data.
        schema:
          type: string
          enum:
          - last24hours
          - last7days
          - last30days
          example: last7days
      - name: token
        in: query
        required: true
        description: API authentication token.
        schema:
          type: string
      responses:
        '200':
          description: Successful response with top mentioned tickers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopMentionResponse'
        '401':
          description: Unauthorized - invalid or missing token
        '429':
          description: Rate limit exceeded
components:
  schemas:
    TopMentionResponse:
      type: object
      description: Response containing top mentioned tickers
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              ticker:
                type: string
                description: Cryptocurrency ticker symbol
              mention_count:
                type: integer
                description: Number of times mentioned in the time period
              sentiment_score:
                type: number
                description: Average sentiment score for mentions
    HeadlinesResponse:
      type: object
      description: Response containing trending headline articles
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/NewsArticle'
        total_pages:
          type: integer
          description: Total number of pages available
    NewsArticle:
      type: object
      description: A cryptocurrency news article
      properties:
        news_url:
          type: string
          format: uri
          description: URL of the original news article
        image_url:
          type: string
          format: uri
          description: URL of the article's featured image
        title:
          type: string
          description: Headline title of the news article
        text:
          type: string
          description: Summary or excerpt text of the article
        source_name:
          type: string
          description: Name of the news source
        date:
          type: string
          description: Publication date and time of the article
        topics:
          type: array
          items:
            type: string
          description: List of topics associated with the article
        sentiment:
          type: string
          enum:
          - Positive
          - Negative
          - Neutral
          description: AI-computed sentiment classification for the article
        type:
          type: string
          description: Type of news content (article, video, etc.)
        tickers:
          type: array
          items:
            type: string
          description: Cryptocurrency tickers mentioned in the article
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: query
      name: token
      description: API key passed as a query parameter named 'token'