Skip to content

Recommended API Workflow

This page maps the recommended sequence for building a news intelligence application with the FinTech Studios API. Each step produces output that feeds directly into the next.

Workflow at a Glance

Step Action Endpoint Produces Required?
1 Authenticate POST /auth/login token, userId Yes
2 Discover Trending Entities GET /analytics/trending/entity Trending entity list Optional
3 Get User's Channels GET /channel/user/{user_id} Channel list with stages One of 3a or 3b
3b Get Channel by ID GET /channel/id/{channel_id} Single channel with stages One of 3a or 3b
4 Read Articles POST /news/user/{user_id}/query Article list with entity ID arrays Yes
5 Resolve Entity IDs GET /entity/ids/{entity_ids} Entity names and metadata Recommended
6 Generate AI Summary POST /generative/generate AI-generated text Optional

Step 1: Authenticate

Endpoint: POST /auth/login

All API calls require a valid security token. Authenticate first and save both the token and your userId. The token has an expiration timestamp — check it before each session and re-authenticate when it expires.

Produces:

  • token — used in the Authorization: Bearer {token} header on every subsequent call
  • userId — used as a path parameter in endpoints that include {user_id} in the path
  • expires — Unix epoch milliseconds; re-authenticate when current time exceeds this

Authentication Instructions

Endpoint: GET /analytics/trending/entity

Use this endpoint to display what is currently hot in the news — companies, people, regions, topics, or all entity types at once. This is a great starting point for building a "trending" widget and requires no additional setup beyond authentication.

Produces:

  • A ranked list of entities with name, type_display, raw_count, moving_average, and deltaPrimeStdDevDifferenceDelta (trend score)

Feeds into: Nothing directly — display this list as-is, or use the entity IDs to build a channel stage.

Trending Endpoint

Step 3a: Get User's Channels

Endpoint: GET /channel/user/{user_id}

Retrieves all channels owned by or subscribed to by the authenticated user, including the stages definition for each. Use this when you want to let users choose from their own channel library.

Produces:

  • A list of channel objects, each containing a stages array ready to pass to Read Articles

Get All Channels Endpoint

Step 3b: Get a Specific Channel Definition

Endpoint: GET /channel/id/{channel_id}

Retrieves a single channel by its numeric ID. Use this when you already know the channel ID you want (e.g., a hardcoded public channel, or a channel ID chosen by the user).

Produces:

  • A single channel object with its stages array

Channel Definition Endpoint

Understanding Stages

Stages are the JSON filter structures extracted from a channel definition. They define what entities, topics, or metadata terms to include or exclude when reading articles. Before passing stages to the Read Articles endpoint, review the Stage Definitions reference.

Stage Definitions

Step 4: Read Articles

Endpoint: POST /news/user/{user_id}/query

Pass the stages array from your channel definition as the payload to fetch articles. The response is a list of article objects, each containing title, summary, url, published, and three arrays of entity IDs (primary_entities, secondary_entities, tertiary_entities).

Requires: user_id (from Step 1), stages (from Step 3a or 3b)

Produces:

  • Article objects with entity ID arrays that need to be resolved

Note

The entity fields (primary_entities, secondary_entities, tertiary_entities) contain integer IDs, not names. Use Step 5 to convert them.

Read Articles Endpoint Entity Relevance Tiers

Step 5: Resolve Entity IDs

Endpoint: GET /entity/ids/{entity_ids}

Takes a comma-separated list of entity IDs and returns their full records — name, type, exchange, symbol, and more. Call this with the IDs from primary_entities, secondary_entities, and/or tertiary_entities on your articles.

Requires: One or more entity IDs from the article response

Produces:

  • Entity records with human-readable name, type_display, symbol, and other metadata

Entity Lookup Endpoint

Step 6 (Optional): Generate AI Summary

Endpoint: POST /generative/generate

Pass article IDs from Step 4 to generate LLM-based summaries, analysis, or answers grounded in the retrieved news content. The API supports both explicit article injection and implicit RAG-based retrieval. Responses are streamed via Server-Sent Events.

Requires: Article IDs from Step 4 (or let the model retrieve articles implicitly via RAG)

Generative API

Implementation Guides

For end-to-end code examples combining multiple steps above, see the Implementation Guides:

Recent News Example Spreadsheet Upload & Channel Management

Home PowerIntell.AI™ Apollo Pro® RegLens®

Last update: March 5, 2026
Back to top