Skip to Content
MID 1.0 is released 🎉

Consents

This document provides an overview of the API endpoints under /v1/service/consents/.


Consents

This section describes the API endpoints for managing companies.

POST /v1/service/consents/search

Description: Creates Consents for a specific merchant user authorization.

Sample Request:

{ "name": "Acme Corp", "email": "acme.corp@arcme.com4", "industry": "Banking", "contact": "Akinteye James", "callbackUrl": "https://acme.example.com/webhook" }

Parameters:

  • query (string, query, required): Search term for stock name or symbol
  • price_type (string, query, required): Filter by price change percentage
  • market_cap_type (string, query, required): Filter by market capitalization type

Available values : mega_cap, large_cap, mild_cap, small_cap, micro_cap

Sample Response:

{ "clientId": "b1e2...f35", "apiKey": "clt_xxxx...", "secret": "shh_xxxx...", "usage": { "auth": 0, "consent": 0, "profileUpdate": 0 }, "lastBilled": "2025-06-08T20:17:06.810Z", "message": "Client registered successfully" }

Screener Data

GET /v1/service/consents/screener/sector

Description: Fetches sector screener data along with related chat summaries.

Response Data:

{ error: false, msg: "Sector screener data received successfully", data: [ { name: "Technology", time_series: [ { timestamp: "2024-09-01T12:00:00Z", value: 150.75 } ] } ], prompt: "The technology sector has shown significant growth in the last quarter." }

Earnings API

Summary

Fetch the summary details for a specific stock symbol, including revenue, strengths, challenges, and other noteworthy summaries.

GET /v1/service/consents/{symbol}/summary

symbol The stock symbol to fetch the summary for.

Response:

{ error: false, message: "Success", body: { summay: { Revenue_Segment: "Alphabet Inc. achieved revenues of $84.742 billion... ", Strengths: "Alphabet highlighted several key strengths in their ...", Challenges: "Despite strong revenue growth, Alphabet Inc. faced ...", Noteworthy_Summary: "Alphabet's Q2 2024 performance underscores ..." }, document_title: "Earnings Report Q3 2024", company_name: "Alphabet Inc.", stock_name: "NASDAQ", ticker: "GOOG", source_documents: [ { document_name: "Form EX-99.1 filed on 2024-07-23", document_url: "https://quantera.ai/sec-filings/GOOG/EX-99.pdf" }, { document_name: "Form 10-Q filed on 2024-07-24", document_url: "https://quantera.ai/sec-filings/GOOG/10-Q.pdf" } ] } }

Press

GET /v1/service/consents/{symbol}/press

symbol The stock symbol to fetch the press for.

Response:

{ error: false, message: success body: { summay: "**FOR IMMEDIATE RELEASE**\n\n** Alphabet Announces Sterling Second Quarter 2024 Results**\n\n MOUNTAIN VIEW, Calif. – July 23, 2024 – Today, Alphabet Inc. (NASDAQ: GOOG, GOOGL) reported its second-quarter 2024 financial results for the period ending June 30, 2024.\", document_title: "Earnings Report Q3 2024", company_name: "Alphabet Inc.", stock_name": "NASDAQ", ticker: "GOOG", source_documents: [ { document_name: "Form EX-99.1 filed on 2024-07-23", document_url: "https://quantera.ai/sec-filings/GOOG/EX-99.1.pdf" }, { document_name: "Form 10-Q filed on 2024-07-24", document_url: "https://quantera.ai/sec-filings/GOOG/10-Q.pdf" } ] } }

Question

Ask question about stock financial for a specific symbol. The endpoint fetch the summary details for a specific stock symbol, including revenue, strengths, challenges, and other noteworthy summaries.

POST /v1/service/consents/{symbol}/question

Parameters:

name: symbol required: true The stock symbol to fetch the summary for. Type: string Example: “GOOG”

Request Body:

{ ticker: "GOOG", question: "What are Alphabet Inc., Inc. biggest financial risks and ...?" }

Response Body:

{ "error":false, "message":"Success", "body":{ "ticker":"GOOG", "question":"What are Alphabet Inc., Inc. biggest financial risks in 2024?", "answer":[ "Response line 1s:", "Response line 2g ning the termination of accounts," including those of sanctioned parties. These disputes resulted in civil judgments with compounding penalties. Although Alphabet did not anticipate these legal matters to have a material adverse effect, the complexity and uncertainty surrounding them posed potential financial risks.","2. **European Commission Fines**: Alphabet faced substantial financial risks from fines imposed by the European Commission for violations of European competition law. Previous fines included €2.4 billion in 2017, €4.3 billion in 2018, and €1.5 billion in 2019. While some fines were reduced on appeal, the financial impact of these fines and any future penalties could be significant.","3. **Share Repurchase Program**: Alphabet's capital allocation strategy included a substantial share repurchase program. In 2024, the company repurchased and retired shares worth $62.0 billion, with an additional $70.0 billion authorized for repurchase. While share buybacks can enhance shareholder value, they also pose risks by potentially limiting investment in growth opportunities or reducing financial flexibility.","These financial risks, if not managed effectively, could impact Alphabet Inc.'s financial performance and shareholder value." ], "document_url":"https://sample.doc.pdf", "source_page":"85" } }

Code Sample - Curl

curl --location 'https://api.quantera.ai/v1/service/consents/GOOG/question' \ --header 'Accept: application/json' \ --header 'X-QuanteraAPI-Key: <YOUR_API_KEY>' \ --header 'Content-Type: application/json' \ --data '{ "symbol": "GOOG", "question": "What are Alphabet Inc., Inc. biggest financial risks in 2024?" }' { "error":false, "message":"Success", "body":{ "ticker":"GOOG", "question":"What are Alphabet Inc., Inc. biggest financial risks in 2024?", "answer":[ "In 2024, Alphabet Inc. faced several significant financial risks:", "1. **Legal Matters in Russia, particularly concerni. These disputes resulted in civil judgments w....", "a material adverse effect, the complexity and uncertainty surrounding them posed potential financial risks.", ], "document_url":"https://quantera-ai-documents.com/data//GOOG/DEF.pdf", "source_page":"85" } }

Code Sample - Javascript, Node.js

async function askQuestion(symbol, questions) { try { const response = await axios.post( `${BASE_URL}/v1/service/consents/${symbol}/question`, { symbol, question }, { headers: { 'Content-Type': 'application/json', 'X-QuanteraAPI-Key': API_KEY, }, } ); console.log('Ask question:', response.data); return response.data; } catch (error) { console.error('Error ask question:', error.message); throw error; } }
Last updated on