> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cryptorank.io/llms.txt
> Use this file to discover all available pages before exploring further.

# News Feed

> Crypto news feed with title, summary, source, tags and related coins/funds.<br/><br/>Available from&#58; <Badge color="green">Advanced</Badge><br/>Cost&#58; <Badge color="surface">1 credit per request</Badge>

> [!NOTE]
>
> Filterable by coin, fund, tag, and date range.

> [!TIP]
>
> `hasMainText` indicates whether a full article body is available via the [news detail endpoint](https://docs.cryptorank.io/api-reference/news/news-detail.md) — fetch it there. Check it before spending a credit on the detail call.


## OpenAPI

````yaml /openapi.json get /v3/news/feed
openapi: 3.0.0
info:
  contact:
    email: info@cryptorank.io
    name: Cryptorank Team
    url: https://cryptorank.io
  description: >
    # Overview


    Cryptorank Public API v3 — comprehensive cryptocurrency data for B2B clients
    and partners.


    Useful Links:

    - [API Plans](https://cryptorank.io/public-api)

    - [Dashboard](https://cryptorank.io/public-api/dashboard)


    # Getting Started


    Primary Server URL:
    [https://api.cryptorank.io/v3/](https://api.cryptorank.io/v3/)


    **Authentication**


    Generate an API key in the
    [dashboard](https://cryptorank.io/public-api/dashboard) and pass it in the
    `X-Api-Key` header.


    Keep your keys secret — never commit them to public repositories or expose
    them in client-side code.
  title: Cryptorank API V3
  version: 3.0.0
servers:
  - url: https://api.cryptorank.io
security: []
tags: []
paths:
  /v3/news/feed:
    get:
      tags:
        - News
      summary: News Feed
      description: >-
        **Description**


        Crypto news feed with title, summary, source, tags and related
        coins/funds.


        > **Note:** Filterable by coin, fund, tag, and date range.


        > **Tip:** `hasMainText` indicates whether a full article body is
        available via the [news detail
        endpoint](https://docs.cryptorank.io/api-reference/news/news-detail) —
        fetch it there. Check it before spending a credit on the detail call.


        **Access**

        - Available from: **Advanced**

        - Cost: 1 credit per request
      operationId: NewsController_getFeed
      parameters:
        - description: >-
            Opaque pagination cursor returned by the previous response as
            `meta.nextCursor`. Pass it back unchanged to fetch the next page.
          in: query
          name: cursor
          required: false
          schema:
            type: string
        - description: Filter by article language. Omit to return all languages.
          in: query
          name: language
          required: false
          schema:
            enum:
              - en
              - ru
              - es
              - zh
              - tr
              - vi
              - pt
              - ko
            type: string
        - description: >-
            Filter by mentioned currency id — only articles that reference it.
            See: [GET
            /v3/currencies/map](https://docs.cryptorank.io/api-reference/currencies/currency-map-id-reference).
          in: query
          name: currencyId
          required: false
          schema:
            example: 1
            type: number
        - description: >-
            Filter by mentioned fund id — only articles that reference it. See:
            [GET
            /v3/funds/map](https://docs.cryptorank.io/api-reference/funds/funds-map-id-reference).
          in: query
          name: fundId
          required: false
          schema:
            example: 12
            type: number
        - description: Filter by tag id — only articles tagged with it.
          in: query
          name: tagId
          required: false
          schema:
            example: 5
            type: number
        - description: >-
            Return articles published on or after this moment (ISO 8601 or Unix
            timestamp in seconds/milliseconds).
          in: query
          name: from
          required: false
          schema:
            type: string
        - description: >-
            Return articles published on or before this moment (ISO 8601 or Unix
            timestamp in seconds/milliseconds). Bare dates (`YYYY-MM-DD`) are
            treated as end-of-day UTC so the named day is included.
          in: query
          name: to
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/NewsFeedItemDto'
                    type: array
                  meta:
                    $ref: '#/components/schemas/CursorMetaDto'
                  status:
                    $ref: '#/components/schemas/ResponseStatusDto'
                required:
                  - data
                  - meta
                  - status
                type: object
          description: ''
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - VALIDATION_ERROR
                        example: VALIDATION_ERROR
                        type: string
                      message:
                        example: Validation failed
                        type: string
                      status:
                        example: 400
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: Request validation failed
        '401':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - API_KEY_MISSING
                          - API_KEY_INVALID
                        example: API_KEY_MISSING
                        type: string
                      message:
                        example: API key is missing
                        type: string
                      status:
                        example: 401
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: API key is missing or invalid
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - NO_ACTIVE_SUBSCRIPTION
                          - ENDPOINT_NOT_AVAILABLE
                          - PLAN_LIMIT_EXCEEDED
                        example: NO_ACTIVE_SUBSCRIPTION
                        type: string
                      message:
                        example: No active subscription found
                        type: string
                      status:
                        example: 403
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: >-
            No active subscription, the endpoint is not available in your plan,
            or the request goes beyond what your plan allows
        '429':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - RATE_LIMIT_EXCEEDED
                          - DAILY_CREDITS_EXCEEDED
                          - MONTHLY_CREDITS_EXCEEDED
                        example: RATE_LIMIT_EXCEEDED
                        type: string
                      message:
                        example: Rate limit exceeded
                        type: string
                      status:
                        example: 429
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: Rate limit or credit limit exceeded
        '500':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - INTERNAL_ERROR
                        example: INTERNAL_ERROR
                        type: string
                      message:
                        example: Internal server error
                        type: string
                      status:
                        example: 500
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: Internal server error
      security:
        - X-Api-Key: []
components:
  schemas:
    NewsFeedItemDto:
      properties:
        assignedFunds:
          description: Funds referenced by the article.
          items:
            $ref: '#/components/schemas/NewsFeedAssignedFundDto'
          type: array
        assignedTokens:
          description: Currencies referenced by the article.
          items:
            $ref: '#/components/schemas/NewsFeedAssignedTokenDto'
          type: array
        hasMainText:
          description: >-
            True when a full article body is available — fetch it from `GET
            /news/{id}/main-text`. False for headline-only items.
          example: true
          type: boolean
        heroText:
          description: Short preview / lead text. Null when the source did not provide one.
          nullable: true
          type: string
        id:
          example: 1234567
          type: number
        language:
          description: Article language. Null when the source did not declare one.
          enum:
            - en
            - ru
            - es
            - zh
            - tr
            - vi
            - pt
            - ko
          example: en
          nullable: true
          type: string
        previewImage:
          description: Preview image URL. Null when the article has no image.
          example: https://img.cryptorank.io/news/abc.jpg
          nullable: true
          type: string
        publishedDate:
          description: Publication timestamp (ISO 8601).
          example: '2024-01-01T12:34:56.000Z'
          type: string
        source:
          description: Source name.
          example: CoinDesk
          type: string
        sourceUrl:
          description: >-
            Link to the original article. Null when the source URL is
            unavailable.
          example: https://www.coindesk.com/markets/2024/01/01/btc-ath
          nullable: true
          type: string
        tags:
          description: >-
            Tags associated with the news item. Each item carries an `id`
            (usable as the `tag` filter), a URL-friendly `key` slug and a
            display `name`.
          items:
            $ref: '#/components/schemas/NewsFeedTagDto'
          type: array
        title:
          example: Bitcoin breaks new all-time high
          type: string
      required:
        - id
        - title
        - heroText
        - source
        - sourceUrl
        - previewImage
        - publishedDate
        - language
        - hasMainText
        - tags
        - assignedTokens
        - assignedFunds
      type: object
    CursorMetaDto:
      properties:
        nextCursor:
          description: >-
            Opaque cursor pointing to the next page; null when no further
            results exist.
          example: eyJpZCI6MTIzNH0=
          nullable: true
          type: string
      required:
        - nextCursor
      type: object
    ResponseStatusDto:
      properties:
        timestamp:
          description: Server time of the response. Unix timestamp in milliseconds
          example: 1780000000000
          type: number
        usedCredits:
          description: Credits charged for this request
          example: 1
          type: number
      required:
        - usedCredits
        - timestamp
      type: object
    NewsFeedAssignedFundDto:
      properties:
        id:
          description: Fund id.
          example: 12
          type: number
        name:
          description: Display name.
          example: Pantera Capital
          type: string
        slug:
          description: URL-friendly fund slug.
          example: pantera-capital
          type: string
      required:
        - id
        - name
        - slug
      type: object
    NewsFeedAssignedTokenDto:
      properties:
        id:
          description: Unique currency identifier.
          example: 1
          type: number
        name:
          description: Display name.
          example: Bitcoin
          type: string
        slug:
          description: URL-friendly currency slug.
          example: bitcoin
          type: string
        symbol:
          description: Currency ticker symbol.
          example: BTC
          type: string
      required:
        - id
        - slug
        - name
        - symbol
      type: object
    NewsFeedTagDto:
      properties:
        id:
          description: Tag id — pass to the `tag` query param to filter.
          example: 5
          type: number
        key:
          description: URL-friendly tag slug.
          example: defi
          type: string
        name:
          description: Display name.
          example: DeFi
          type: string
      required:
        - id
        - key
        - name
      type: object
  securitySchemes:
    X-Api-Key:
      in: header
      name: X-Api-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.