सामग्रीवर जा

API आणि MCP दस्तऐवज

FinancialMD SEC फायलिंगमधून तयार केलेली वित्तीय विवरणे पुरवते. प्रत्येक संख्या ज्या फायलिंगमधून आली आहे त्याला लिंक केलेली असते, आणि प्रत्येक संख्या कोणत्याही तारखेला जशी ज्ञात होती तशी वाचता येते. खात्याची गरज नाही.

पहिला कॉल करा

API हे HTTPS वर JSON आहे. हा कॉल Apple चे शेवटचे पाच वार्षिक उत्पन्न विवरण परत करतो. यासाठी कोणत्याही कीची आवश्यकता नाही.

curl "https://api.financial.md/v1/company/financials/income_statement/standardized?company=ticker:AAPL&period_type=annual&limit=5"

हे विवरण income_statement, balance_sheet, cash_flow किंवा supplemental यापैकी एक असते. कालावधी प्रकार annual, quarterly, ltm किंवा ytd यापैकी एक असतो.

कंपनीचे नाव सांगा

प्रत्येक कंपनीचा मार्ग company मापदंड घेतो.

  • ticker:AAPL, किंवा एक्सचेंजचे नाव द्यायचे असल्यास ticker:AAPL.XNAS
  • cik:320193, SEC चा कंपनी क्रमांक
  • fmd_<id>, FinancialMD कंपनीला दिलेला आयडी

फक्त AAPL दिल्यास तो टिकर म्हणून वाचला जातो आणि फक्त अंक दिल्यास ते CIK म्हणून वाचले जातात. प्रतिसादात काय जुळले ते meta.company.matched_by मध्ये दिलेले असते.

मूल्य वाचा

यशस्वी प्रतिसाद { data, meta } असतो. data मधील संख्या कधीही उघडी नसते. ती एक मूल्य ऑब्जेक्ट असते:

{
  "value": 391035000000,
  "unit": "USD",
  "currency": "USD",
  "decimals": -6,
  "period": { "start": "2023-10-01", "end": "2024-09-28", "type": "annual", "fiscal_year": 2024, "fiscal_period": "FY" },
  "known": { "from": "YYYY-MM-DDThh:mm:ssZ", "to": null },
  "restated": false,
  "method": "as_filed",
  "calc_type": "as_filed",
  "proof": { "id": "p_...", "accession": "0000320193-24-000123", "form": "10-K", "filed": "2024-11-01", "taxonomy": "us-gaap", "tag": "...", "source_url": "https://www.sec.gov/..." }
}

known हा तो कालावधी आहे ज्यामध्ये हा सर्वात अलीकडील फायल केलेला आकडा होता. restated फक्त तेव्हाच true असते जेव्हा नंतरच्या फायलिंगने हा आकडा बदलला असेल; त्यानंतर restatement_kind ते कसे बदलले ते सांगते. proof.id हे GET /proof/{id} वर त्या मूल्यासाठीची फायलिंग आणि त्या मूल्यामागील कच्ची तथ्ये याकडे निराकरण होते.

भूतकाळ जसा माहीत होता तसा वाचा

  • कोणत्याही वाचन मार्गावर as_of=2024-06-30 दिल्यास त्या क्षणी जे ज्ञात होते ते परत मिळते.
  • original=true प्रत्येक कालावधीची प्रथम-अहवालित आवृत्ती परत करते.
  • history=true प्रत्येक कालखंडाची प्रत्येक आवृत्ती परत करते, सर्वात जुनी प्रथम.
  • GET /v1/changes?since=<timestamp> तेव्हापासून ज्ञात झालेल्या तथ्यांची यादी करते.

रूट्स

रूटते काय परत करते
GET /v1/companiesफिल्टर आणि पेजिंगसह कंपनी निर्देशिका
GET /v1/company/profileप्रोफाइल, सूची आणि उपलब्ध डेटासेट
GET /v1/company/metricsकंपनीच्या टेम्पलेटमधील संकल्पना पंक्ती
GET /v1/company/financials/{statement}/standardizedएक प्रमाणित विवरण
GET /v1/company/financials/{statement}/as_reportedटॅगसह फायलरचे स्वतःचे लाइन आयटम
GET /v1/company/ratiosविवरणांमधून मोजलेली गुणोत्तरे, त्यांच्या इनपुटच्या पुराव्यांसह
GET /v1/company/ratios/daily/{ratio_id}कालावधी दरम्यान मालिका म्हणून एक गुणोत्तर
GET /v1/company/filingsकंपनीचा फायलिंग निर्देशांक
GET /v1/filing/{accession}एक फायलिंग
GET /v1/filing/{accession}/factsफायलिंगने टॅग केलेले प्रत्येक मॅप केलेले तथ्य
GET /v1/filing/{accession}/documentEDGAR वरील फायलिंगच्या पानांचे दुवे, किंवा त्याचा प्राथमिक दस्तऐवज HTML, PDF किंवा पृष्ठ प्रतिमांमध्ये
GET /v1/company/ownership/insidersफॉर्म 3, 4 आणि 5 मधील अंतर्गत व्यवहार
GET /v1/company/ownership/institutionalएका कंपनीचे Form 13F धारक, तिमाहीनुसार
GET /v1/ownership/institutional/holdersफॉर्म 13F व्यवस्थापक
GET /v1/ownership/institutional/holdingsएका तिमाहीसाठी एका व्यवस्थापकाचे 13F पोर्टफोलिओ
GET /v1/company/splitsदाखल केल्याप्रमाणे स्टॉक स्प्लिट्स, आणि किंमती त्यांची पुष्टी करतात की नाही
GET /v1/company/dividendsदाखल केल्याप्रमाणे प्रत्येक कालावधीत घोषित किंवा दिलेला प्रति समभाग लाभांश
GET /v1/events_calendarअर्निंग्स रिलीझ (8-K Item 2.02 दाखल केलेले) आणि मॉडेल-अपेक्षित तारखा
GET /v1/company/events8-K आयटम्स: फायलिंग-आधारित इव्हेंट फीड
GET /v1/newsप्रत्येक कव्हर केलेल्या कंपनीची 8-K फायलिंग्ज, सर्वात नवीन प्रथम, इव्हेंट प्रकार आणि महत्त्व पातळीसह
GET /v1/news/feedFinancialMDचे स्वतःचे इव्हेंट फीड, प्रत्येक इव्हेंट-असलेल्या SEC फॉर्ममधून, नियम-निर्मित मथळे, महत्त्व आणि मुख्य आकड्यांसह. वायर न्यूज नाही
GET /v1/news/issuer_releasesजारीकर्त्यांनी स्वतःबद्दल प्रकाशित केलेले रिलीझ: SEC exhibits, आणि जारीकर्त्याच्या स्वतःच्या फीडमधील मथळा व दुवा
GET /v1/company/call_materialsजारीकर्त्याने SEC कडे दाखल केलेली अर्निंग्स-कॉल सामग्री: रिलीझ, तयार केलेल्या टिप्पणी, पत्रे, सादरीकरणे, आणि दाखल केले असल्यास ट्रान्सक्रिप्ट
GET /v1/call_material/{id}विभाग, वक्त्यांचे वळण आणि विषय टॅगसह उताऱ्यांच्या स्वरूपातील एक जारीकर्ता-दाखल दस्तऐवज
GET /v1/calls_calendarजारीकर्ते SEC फायलिंगमध्ये जशी घोषणा करतात तसे अर्निंग्स कॉल, जारीकर्त्याच्या स्वतःच्या वेबकास्ट पृष्ठाच्या दुव्यासह
GET /v1/search/filings2001 पासून EDGAR दस्तऐवजांचा पूर्ण-मजकूर शोध (SEC EDGAR पूर्ण-मजकूर शोध)
GET /v1/coverageप्रत्येक डेटासेट त्याच्या स्थितीसह: उपलब्ध, कव्हर नाही (licensed) किंवा तयार नाही, आणि त्याऐवजी काय वापरावे
GET /v1/company/estimatesFinancialMDचे स्वतःचे मॉडेल-आधारित baseline estimates, intervals आणि पॉइंट-इन-टाइम ट्रॅक रेकॉर्डसह, कंपनीचे मार्गदर्शन त्याच्या फायलिंगमध्ये नमूद केल्याप्रमाणे, आणि वर्णनात्मक signals. एकमत नाही, analyst estimates नाही. पद्धत पहा
GET /v1/company/estimates/consensusकव्हर नाही: consensus estimates licensed आहेत. 404 not_covered पर्यायांसह उत्तर देते
GET /v1/company/analyst_ratingsकव्हर नाही: analyst ratings licensed आहेत. 404 not_covered उत्तर देते
GET /v1/company/transcriptsकव्हर नाही: call transcripts licensed आहेत. 404 not_covered उत्तर देते
GET /v1/company/stock_prices/intradayसमाविष्ट नाही: रिअल-टाइम आणि इंट्राडे किंमती परवानाकृत आहेत. 404 not_covered परत करते
GET /v1/company/logoकंपनी ओळखण्यासाठी एक लोगो: त्याचे श्रेयासह खुले परवान्याची फाइल, किंवा तयार केलेला टाइल. JSON, SVG किंवा PNG
GET /v1/politician_tradesयूएस हाऊस सदस्यांचे ट्रेड्स, नियतकालिक व्यवहार अहवालांमध्ये जसे फाइल केले आहेत तसे, अधिकृत अहवालासह. कधीही किंमत दिलेली नाही. वापर 5 U.S.C. 13107(c)(1) ने मर्यादित आहे: data.notice वाचा
GET /v1/company/segmentsजसे-अहवालित विभागीय तथ्ये (व्यवसाय, भूगोल, उत्पादन)
GET /v1/company/ownership/insider_holdersप्रत्येक इनसाइडरकडे त्यांच्या नवीनतम Form 4 किंवा 5 नंतर काय मालकी होती
GET /v1/company/ownership/fundsत्यांच्या नवीनतम N-PORT मध्ये कंपनी धारण करणारे फंड
GET /v1/fundsत्यांच्या नवीनतम अहवालासह N-PORT फंड
GET /v1/fund/holdingsएका फंडाची N-PORT होल्डिंग्ज
GET /v1/company/kpisकंपनीने अहवालित केलेले समायोजित आणि ऑपरेटिंग मेट्रिक्स, प्रत्येकास त्याच्या संदर्भासह
GET /v1/company/dividend_eventsदाखल केल्याप्रमाणे त्यांच्या तारखांसह रोख लाभांश
GET /v1/company/ownership/insider_holdingsForms 3, 4 आणि 5 मधील होल्डिंग ओळी
GET /v1/fund/profileN-CEN मधील फंडाचा प्रकार आणि त्याच्या शेअर क्लासेसची शुल्के
GET /v1/fund/navअहवाल महिन्यानुसार फंडाची निव्वळ मालमत्ता, प्रत्येक वर्गाचा आमच्या परतावा निर्देशांकासह मासिक परतावा आणि SEC फाइलिंगमधून प्रति शेअर बंद-अंत NAV. दैनंदिन NAV दिली जात नाही
GET /v1/identifiers/xrefएका अभिज्ञापकावरून, तो ज्या कंपनीला किंवा फंडाला दर्शवतो ते आणि इतर खुले अभिज्ञापक, प्रत्येकास त्याच्या स्रोतासह
GET /v1/identifiers/masterप्रत्येक कंपनीचे खुले अभिज्ञापक, पृष्ठांकित
GET /v1/company/stock_prices/returnsकिंमत परतावा, एकूण परतावा आणि मानक विंडोमधील कमाल ड्रॉडाउन, end-of-day bars आणि SEC-filed splits व लाभांश यांवरून गणना केलेले
GET /v1/company/identifiersLEI आणि त्यांच्या पुराव्यांसह FIGI
GET /v1/company/stock_pricesफक्त IEX वरील ट्रेड्समधून तयार केलेले दैनिक bars. consolidated tape नाही. डीफॉल्टने raw; adjust=splits किंवा adjust=total_return समायोजित मूल्ये जोडते
GET /v1/screenनवीनतम-कालावधीतील मेट्रिक्सवर प्रत्येक समाविष्ट कंपनीचे स्क्रीनिंग करा
POST /v1/verifyएका संख्येची फाइल केलेल्या मूल्याशी पडताळणी करा
GET /v1/changesज्या तथ्यांचे ज्ञान एखाद्या वेळेनंतर उपलब्ध झाले
POST /v1/request-dataआपल्याला कोणता डेटा हवा होता आणि सापडला नाही ते आम्हाला सांगा. की नाही, कधीही शुल्क नाही, साप्ताहिक पुनरावलोकन. विनंती कशी करावी पहा
GET /v1/request-dataPOST /v1/request-data चे body घेते
GET /v1/request-data/{id}विनंतीची स्थिती: new, triaged, planned, done किंवा wontfix
GET /v1/requestedविनंती केलेले आणि पाठवलेले: मोजणीसह पुनरावलोकित विनंत्या, सबमिटरचे तपशील नाहीत
GET /proof/{id}सर्व्ह केलेल्या मूल्याचा पुरावा
GET /v1/company/line_itemsलेबल आणि कालावधीनुसार एक अहवालित ओळ: जसे-अहवालित तपशील ओळी, विभागीय आकडे, कंपनी मेट्रिक्स आणि मार्गदर्शन
GET /v1/screen/nlसोप्या भाषेतील स्क्रीन: प्रश्नाचे स्क्रीन फिल्टरमध्ये विश्लेषण केले जाते (AI model किंवा निश्चित नियमांद्वारे, लेबल केलेले) आणि GET /v1/screen म्हणून चालवले जाते
GET /v1/askएका कंपनीबद्दल तिच्याच फाइल केलेल्या मूल्यांवर आधारित AI-लिखित उत्तर, ज्यातील प्रत्येक संख्या उद्धृत तथ्यांशी पडताळलेली आहे
GET /v1/news/summaryFinancialMD च्या स्वतःच्या इव्हेंट फीडमधून एका दिवसाच्या फायलिंग-आधारित बातम्यांचा किंवा एका कंपनीच्या अलीकडील घटनांचा AI-लिखित सारांश; प्रत्येक बुलेट त्याच्या फायलिंग्जचा संदर्भ देते आणि प्रत्येक संख्या त्यांच्याशी पडताळली जाते
GET /v1/company/ratios/forwardआमच्या स्वतःच्या model-based estimates वरचे forward valuation ratios (लेबल केलेले model output, consensus कधीही नाही), अंदाज, त्याचा interval आणि त्याचा track record यांसह
GET /v1/company/technicalssingle-venue daily bars आणि SEC-filed splits वरून गणना केलेले technical indicators (moving averages, RSI, MACD, Bollinger bands, ATR, close range)
GET /v1/pre_ipoसार्वजनिक होण्यासाठी फायलिंग केलेल्या कंपन्या: कोणत्याही नियतकालिक अहवालापूर्वी फाइलवर S-1 किंवा F-1 असलेले registrants, स्थिती, प्रस्तावित ticker आणि तारखांसह
GET /v1/pre_ipo/{cik}एक pre-IPO registrant: स्थिती आणि त्याचा नियम, नोंदणी फायलिंग्ज, त्याने टॅग केलेले आर्थिक आकडे आणि prospectus मधून वाचलेल्या ऑफरच्या अटी
GET /v1/fx_ratesEuropean Central Bank च्या सार्वजनिक फाइल्समधील दैनिक संदर्भ विनिमय दर, euro मार्फत कोणत्याही दिलेल्या चलनाचा कोणत्याही दुसऱ्या चलनाविरुद्ध दर; संदर्भ दर, व्यापारयोग्य quotes नाहीत
GET /v1/researchCC BY 4.0 परवान्याअंतर्गत स्वतंत्र संशोधन अहवाल, जे त्यांच्या प्रकाशकाच्या साइटवरही शुल्काशिवाय वाचता येतात: कंपनी, संग्रह, भाषा, शब्द आणि तारखेनुसार शोधा, आणि प्रत्येकास अहवालाच्या स्वतःच्या शब्दांत सारांश आहे
GET /v1/research/{id}संरचित मार्कडाउन म्हणून एक संशोधन अहवाल: विभाग, टिकर, तारीख, स्त्रोत, परवाना आणि उद्धृत करताना ठेवण्यासाठी श्रेय
POST /v1/feedbackकाय काम केले आणि काय नाही ते आम्हाला सांगा: एक टीप, रेटिंग किंवा कारणे. की नाही, कधीही शुल्क नाही. GET /v1/feedback body चे वर्णन करते
POST /v1/data-errorsतुमच्या मते चुकीचा असलेला एखादा आकडा नोंदवा. त्याची तुलना आम्ही लगेच देतो त्याच्याशी आणि SEC फायलिंगशी दररोज केली जाते. त्यानंतर GET /v1/data-errors/{id} वापरा

OpenAPI document मध्ये प्रत्येक parameter आणि response schema आहे. llms.txt, llms-full.txt आणि skill file एजंट्ससाठी तेच सांगतात; https://api.financial.md/docs हा परस्परसंवादी संदर्भ आहे आणि https://api.financial.md/changelog बदलांची यादी देते.

एखादा आकडा तपासा

curl -X POST "https://api.financial.md/v1/verify" -H "content-type: application/json" \
  -d '{"company":"ticker:AAPL","concept":"income_statement_total_revenues","period":"FY2024","value":391035000000}'

उत्तरात verdict म्हणून matches, differs किंवा unknown, फायल केलेले मूल्य त्याच्या पुराव्यासह, फरक, आणि तुमची संख्या दहाच्या घाताने चुकली असल्यास scale_hint असते.

मर्यादा

कीशिवाय कॉल प्रत्येक IP पत्त्यासाठी, दररोज मर्यादित आहेत.

  • 10 metered calls: गुणोत्तर, स्क्रीन, पडताळणी आणि प्रत्येक किंमत असलेला route, उदा. standardized statements, segments आणि KPI
  • 1,000 फायलिंग-स्तर वाचने: as-reported facts, फायलिंग्ज, मालकी आणि किंमती
  • 1,000 मेटाडेटा वाचने: निर्देशिका, प्रोफाइल, मेट्रिक्स, पुरावे आणि बदल

प्रत्येक प्रतिसादात RateLimit-Limit, RateLimit-Remaining आणि RateLimit-Reset असतात. 429 मध्ये Retry-After असते.

api.financial.md वरील कीशिवाय कॉलसाठी कधीही शुल्क आकारले जात नाही. API की Terminal + Agent योजनांसह येतात; API keys पहा. एजंट agent.financial.md वर प्रति कॉल पैसेही देऊ शकतात. Pricing पहा.

काय समाविष्ट आहे

कव्हरेजमध्ये अशा कंपन्या येतात ज्या SEC कडे फायलिंग करतात आणि आज US एक्सचेंजवर सूचीबद्ध आहेत.

  • US GAAP अंतर्गत अहवाल देणाऱ्या filers साठी प्रमाणित विवरणे उपलब्ध आहेत.
  • IFRS अंतर्गत अहवाल देणाऱ्या filers, जसे Form 20-F किंवा 40-F फायल करणाऱ्या अनेक परदेशी कंपन्या, यांच्याकडे फायलिंग्ज आहेत पण अद्याप प्रमाणित विवरणे नाहीत.
  • ज्या कंपन्या डीलिस्ट झाल्या आहेत त्या त्यांच्या विवरणे आणि फायलिंग्जसह निर्देशिकेत आहेत. त्यांना CIK ने शोधा: त्यांच्यासाठी ticker lookup नाही आणि किंमतीही नाहीत, त्यामुळे price history मध्ये फक्त आज सूचीबद्ध कंपन्यांचा समावेश आहे.
  • मालकीचा डेटा 1 जुलै 2026 पासून केलेल्या फायलिंगमधून येतो आणि EDGAR daily index मधून दररोज 13:00 UTC ला अद्यतनित केला जातो: समाविष्ट कंपन्यांच्या Form 3, Form 4 आणि Form 5 मधील insider transactions, आणि प्रत्येक Form 13F-HR, त्यामुळे नवीन तिमाहीचे 13F अहवाल व्यवस्थापक फायल करताच येतात. एखादी 13F position कंपनीशी फक्त तेव्हाच जोडली जाते जेव्हा Schedule 13D किंवा 13G cover तिच्या security चे नाव देते. 30 जून, 2026 रोजी संपलेल्या तिमाहीसाठी यामुळे नोंदवलेल्या मूल्याच्या 80 percent जोडले जातात; उर्वरित positions व्यवस्थापकाच्या portfolio मध्ये issuer name खाली, जसे फायल केले आहे तसे, दिसतात.
  • Consensus estimates आणि earnings call transcripts दिले जात नाहीत: दोन्ही licensed data आहेत. Segments अहवालात जसे दिले आहेत तसे दिले जातात, आणि news म्हणजे 8-K फायलिंग्जचे feed आहे.

जेव्हा एखादी कंपनी ज्ञात असते पण एखादा dataset उपलब्ध नसतो, तेव्हा API not_covered असे उत्तर देते आणि उपलब्ध datasets ची यादी करते.

MCP सर्व्हर

MCP सर्व्हर त्याच API ला 57 read-only tools मध्ये सादर करतो. तो MCP Streamable HTTP बोलतो आणि कोणत्याही खात्याची गरज नसते.

https://mcp.financial.md/mcp

MCP मार्गदर्शक साधनांची यादी करते. सर्व्हर कार्ड नोंदणीसाठी आहे.

त्रुटी

त्रुटी अशी असते: { "error": { code, message, docs, request_id, remedies } }. remedies यादी पुढे काय करायचे ते सांगते. त्रुटी संदर्भ प्रत्येक कोडचे स्पष्टीकरण देतो.