> For the complete documentation index, see [llms.txt](https://docs.heron-intelligence.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.heron-intelligence.com/documentation/data-models.md). # Data Models Comprehensive reference for all data structures used in the Heron Intelligence Data Product API. Schemas are embedded in each endpoint's interactive reference. See [API Reference](/api-reference/api-reference.md) to explore them with the Test It functionality. ## Interview call types * `MDD` refers to Heron Intelligence's Management Due Diligence methodology which evaluates leadership skill sets, strategies, and ethics by speaking to high-level sources with firsthand knowledge. * `BDD` refers to Heron Intelligence's Business Due Diligence methodology by interviewing customers, competitors, and key decision-makers to deliver differentiated views of marketplace position and competitive landscape. Filter on these with the `due_diligence_type` query parameter on [`GET /interviews`](/api-reference/api-reference/interviews.md). Not every dataset produces both — `Paragon`, for instance, produces MDD only. See [Data Providers](/documentation/data-providers.md). ## Pagination envelope Every list endpoint — companies, interviews, people, research requests — returns the same two-key envelope: ```json { "data": [ ... ], "pagination": { "current_page": 1, "per_page": 20, "total_items": 137, "total_pages": 7, "has_next": true, "has_previous": false, "next_page": 2, "previous_page": null } } ``` `page` starts at 1. `per_page` defaults to 20 and is capped at 100; a larger value returns `422`. `next_page` and `previous_page` are `null` at the ends of the range — prefer them over incrementing `current_page` yourself. `GET /api/v1/watchlist`, `GET /api/v1/webhooks` and `GET /api/v1/data-sources` are **not** paginated; they return a plain array. ## Enumerations | Field | Where | Values | | ---------------------------- | -------------------------------- | ------------------------------------------ | | `transcript_type` | Interview filter and response | `conversation`, `monologue` | | `due_diligence_type` | Interview filter | `BDD`, `MDD` | | `template` | Research request create | `bdd`, `mdd`, `public_records` | | `status` | Research project | `submitted`, `in_process`, `done` | | `current_step` | Research project | `scope`, `setup`, `questions`, `submitted` | | `brief_status` | Research project | `active`, `frozen`, `submitted` | | `brief_readiness_level` | Research project | `Low`, `Medium`, `High` | | `estimated_interview_volume` | Research request | `1-10`, `11-25`, `25+`, `bh-advice` | | `willingness_to_pay` | Research request | `yes`, `no`, `define-with-sales` | | `scope` | Research request list and detail | `user`, `firm` | | `event_type` | Webhook subscription | `research_request.transcript_added` | Values are case-sensitive as written. A value outside the set returns `422` — see [Error Handling](/documentation/error-handling.md#the-422-validation-body). ## Nullability These fields are easy to assume present and are not. Guard for them rather than indexing straight through. | Object | Always sent, but may be `null` | May be omitted entirely | | --------- | --------------------------------------------------------------------------------- | -------------------------------------------------------- | | Company | `stock_ticker`, `exchange`, `isin` | — | | Interview | `call_date`, `post_date`, `call_type`, `length`, `research_id`, `transcript_type` | `metadata`, `data_source_provider`, `transcript_summary` | | Person | `title`, `bio` | — | Treat "absent" and "`null`" the same way in client code — use a defaulting accessor (`interview.get("data_source_provider") or {}`) rather than a key lookup. ## List of exchanges | IPO Exchange | Target/Issuer | | ------------ | ------------------------------------------------------------------------ | | ADX | Abu Dhabi Securities Exchange | | AIM | London Stock Exchange AIM Market | | ARCA | NYSE Arca | | ASE | Amman Stock Exchange | | ASX | Australian Securities Exchange | | ATSE | The Athens Stock Exchange | | BATS | Better Alternative Trading System | | BAX | Bahrain Stock Exchange | | BASE | Buenos Aires Stock Exchange | | BDB | Bourse de Beyrouth | | BDL | Bourse de Luxembourg | | BDM | Bolsa de Madrid | | BDV | Bolsa de Valencia | | BELEX | Belgrade Stock Exchange | | BER | The Bermuda Stock Exchange | | BITE | Borsa Italiana ETFplus | | BIT | Borsa Italiana | | BITS | Borsa Italiana SeDeX | | BLSE | Bilbao Stock Exchange | | BME | Bolsas y Mercados Espanoles | | BMV | Bolsa Mexicana de Valores | | BOVESPA | Bolsa de Valores de Sao Paulo | | BSE | Mumbai Stock Exchange | | BSM | Botswana Share Market | | BST | Boerse-Stuttgart | | BSSE | Bratislava Stock Exchange | | BUSE | Budapest Stock Exchange | | BVC | Bolsa de Valores de Colombia | | BVB | Bucharest Stock Exchange | | BVL | Bolsa de Valores de Lima | | BVRJ | Bolsa de Valores de Rio de Janeiro | | BVMT | Bourse des Valeurs Mobilieres | | BUL | Bulgaria Stock Exchange | | CATS | SIBE - Spanish Stock Exchange Interconnection System | | Catalist | Singapore Exchange Catalist Market | | CBOE | Chicago Board Options Exchange | | CBSE | Casablanca Stock Exchange | | CCSE | Caracas Stock Exchange | | CHX | Chicago Stock Exchange | | CISX | Channel Islands Stock Exchange | | CNSX | Canadian National Stock Exchange | | COSE | Colombo Stock Exchange | | CPSE | OMX Nordic Exchange Copenhagen | | CSE | Cyprus Stock Exchange | | DAR | Tanzania Stock Exchange | | DB | Deutsche Boerse AG | | DFM | Dubai Financial Market | | DIFX | NASDAQ Dubai Limited | | DSE | Dhaka Stock Exchange Ltd. | | DSM | Doha Securities Market | | DUSE | Dusseldorf Stock Exchange | | ENXTAM | Euronext Amsterdam | | ENXTBR | Euronext Brussels | | ENXTLS | Euronext Lisbon | | ENXTPA | Euronext Paris | | FKSE | Fukuoka Stock Exchange | | GHSE | Ghana Stock Exchange | | GYSE | Guayaquil Stock Exchange | | HLSE | OMX Nordic Exchange Helsinki | | HMSE | Hamburg Stock Exchange | | HNSE | Hannover Stock Exchange | | HNX | Hanoi Stock Exchange | | HOSE | Ho Chi Minh Stock Exchange | | IBSE | Borsa Istanbul (BIST) | | ICSE | OMX Nordic Exchange Iceland | | IDX | Indonesia Stock Exchange | | ISE | Irish Stock Exchange | | JASDAQ | TSE JASDAQ | | JMSE | The Jamaica Stock Exchange | | JSE | The Johannesburg Securities Exchange | | KAS | Kazakhstan Stock Exchange | | KASE | Pakistan Stock Exchange Limited | | KLSE | Bursa Malaysia | | KOSE | Korea Stock Exchange | | KOSDAQ | KOSDAQ | | KWSE | Kuwait Stock Exchange | | LJSE | Ljubljana Stock Exchange | | LSE | London Stock Exchange | | LUSE | Lusaka Stock Exchange | | MAL | Malawi Stock Exchange | | MICEX | Moscow Interbank Currency Exchange | | MISX | Micex - Rts | | MSM | Muscat Securities Market | | MTSE | Malta Stock Exchange | | MUN | Boerse Muenchen | | MUSE | The Stock Exchange of Mauritius Ltd. | | MutualFund | Mutual Funds | | NASE | Nairobi Stock Exchange | | NasdaqCM | Nasdaq Capital Market | | NasdaqGM | Nasdaq Global Market | | NasdaqGS | Nasdaq Global Select | | NGSE | Nigerian Stock Exchange | | NGM | Nordic Growth Market | | NMSE | Namibian Stock Exchange | | NSE | Nagoya Stock Exchange | | NSEI | National Stock Exchange of India | | NSEL | OMX Nordic Exchange Vilnius | | NSX | National Stock Exchange of Australia | | NZSE | New Zealand Stock Exchange | | OB | Oslo Bors | | OFEX | ICAP Securities & Derivatives Exchange (ISDX) | | OM | OMX Nordic Exchange Stockholm | | OSE | Obsolete - formerly Osaka Securities Exchange (OSE) | | OTCBB | OTC Bulletin Board | | OTCPK | Pink Sheets LLC | | OTCNO | Norway OTC | | OTCSG | Singapore OTC | | OTCUS | Other "Grey Market" OTC | | PLSE | Palestine Securities Exchange | | PSE | Philippines Stock Exchange | | RASDAQ | RASDAQ | | RISE | OMX Nordic Exchange Riga | | SASE | Saudi Arabian Stock Exchange | | SEAQ | SEAQ International | | SEATS | SEATS | | SEHK | The Stock Exchange of Hong Kong Ltd. | | SEP | The Stock Exchange Prague Co. Ltd. | | SET | The Stock Exchange of Thailand | | SGX | Singapore Exchange | | SHSC | Stock Exchange of Hong Kong Limited - Shanghai - Hong Kong Stock Connect | | SHSE | Shanghai Stock Exchange | | SNSE | Santiago Stock Exchange | | SOMA | Sociedade Operadora do Mercado de Ativos S A | | SPSE | Sapporo Stock Exchange | | SWX | SIX Swiss Exchange | | SZSC | The Stock Exchange of Hong Kong - Shenzhen - Hong Kong Stock Connect | | SZSE | Shenzhen Stock Exchange | | TASE | The Tel-Aviv Stock Exchange | | THAMSE | Bangkok-Alien Market Stock Exchange | | THSE | Tehran Stock Exchange | | TLSE | OMX Nordic Exchange Tallinn | | TPEX | Taipei Exchange | | TSE | The Tokyo Stock Exchange | | TSX | The Toronto Stock Exchange | | TSXV | TSX Venture Exchange | | TTSE | Trinidad & Tobago Stock Exchange | | TWSE | Taiwan Stock Exchange | | UGSE | Uganda Stock Exchange | | UKR | PFTS Ukraine Stock Exchange | | VIRTX | SWX Europe Limited | | WBAG | Wiener Boerse AG | | WSE | Warsaw Stock Exchange | | XSAT | Aktietorget | | XSEC | Shenzhen Stock Exchange - Shenzhen-Hong Kong Stock Connect | | XSSC | Shanghai Stock Exchange - Shanghai - Hong Kong Stock Connect | | XTRA | XETRA Trading Platform | | ZGSE | Zagreb Stock Exchange | | ZMSE | Zimbabwe Stock Exchange |