API documentation

Deal Book

The Deal Book is your team's list of origination leads in the dashboard. Each deal is assembled from researched public sources, such as tenders, contract awards, financings and export credit agency cover, and every fact behind it links to its source. The same rows are served over the API as GET /v1/deals and to AI assistants over MCP as the tool deal_book, with the same values, dates and order. A new workspace's book holds the deals of the shared deal pool for the desk of each of its teams from the moment the workspace or the team is set up, each deal scored for that team, and on the API and in MCP these deals carry from_pool true.

What each column shows

Deal names the transaction in one line, with its country and sector under it where the sources state them. A deal that names several countries in one phrase, such as Israel and Portugal, lists each of them, and in the API countries and countries_iso3 name the same countries in the same order, one entry each. A place no country name resolves, such as a region, stays the primary country as written with no code.
Financing window reads one short phrase, Financing open, Early stage, Not confirmed or Financing set. Pointing at it shows the detailed state a source confirmed, which the deal page names its Stage.
Value is the deal's value in US dollars as one figure. The cell never prints the sources' own words. Where they state the amount in a way that is not one dollar figure, such as in words alone or as several amounts, the cell is empty, its hover says so, and the deal page shows the amount as the source wrote it under Key facts. A value that no source quote confirms is shown muted, with the reason on hover. An empty cell whose hover reads Value not reported means no amount is reported. No cell of the list widens its column, so one long entry never cuts the names or pushes Last activity out of view. In the API the value to print is value_text, value_status says whether a quote confirms it, and contract_value_usd holds the Value's one amount in US dollars, the amount itself where it is stated in dollars, else the dollar figure the source gives beside it in brackets, else the amount converted at the euro foreign exchange reference rates the European Central Bank published for 29 October 2026, or at an official fixed parity for the Gulf currencies pegged to the dollar, the CFA franc, the Bulgarian lev and a few more such as the pataca, and for most other currencies at the dollar value of the SDR the IMF published for that day, which the African Development Bank's unit of account shares, or at the US Treasury Reporting Rates of Exchange of 30 September 2026 or a later amendment of one of them, such as TWD 9.2 billion, 145.5 million SDR or UA 30.10 million. One amount whose digits spaces or an apostrophe group, such as 527 633,67 EUR or CHF 545'400, is one number, while digits that could be two numbers, such as Lot 2 150 000,00 EUR, give no figure. The figure is rounded to the last place the source states and never more coarsely than the Deal Book prints it, so GBP 82m gives 109000000 and EUR 1bn gives 1100000000, while an amount stated to the cent or in dollars keeps its cents. A bound is never a point figure. Where the Value states at least an amount, such as exceeding EUR 1bn, more than SEK 100 million or EUR 900+ million, or at most one, such as up to $1.1bn, contract_value_usd is empty, contract_value_bound reads at_least or up_to and contract_value_usd_min or contract_value_usd_max holds the bound in dollars, a lower bound rounded down and an upper bound rounded up, so it never claims more than the source. A range, such as between EUR 50 million and EUR 150 million, reads range with both ends. The Deal Book prints such a Value from these dollar bounds, such as “at least $1.1bn”, “up to $3.1bn” or “$55m to $167m”. It is empty for a Value that states several amounts or ranges, for a change from one figure to another, for a price per unit, for an amount that cannot be read as one figure, such as USD 500 odd million, and for a currency without such a rate. A sign or word several currencies share names no currency, such as Rs, P, lira, lei or pesos without the country, so Rs 715 crore stays in the source's words while INR 73.52 crore and ₹1,650 Cr convert. Where a reported Value has no dollar figure, contract_value_usd_unread says why, several_amounts, price_per_unit, not_one_figure, no_currency, shared_currency for such a shared sign or word, or no_rate for a currency without a documented rate. The value sort, min_value_usd, the value floor, the totals and the ticket fit of the score read the highest figure the Value states, the amount, its bound or the upper end of its range, so a deal of more than USD 1.1 billion passes a USD 500 million floor, and the score's words say at least or up to beside a bound. The sort key is exact to the cent, and a currency the Value names by its word or sign converts too, such as 6.9 trillion won, 2 billion reais, FCFA 93 million or TL 17 million, while a word several currencies share, such as pesos or kronor without the country, converts nothing. contract_value_conversion says how the figure was reached, stated_usd, source_usd for the source's own dollar figure, or reference_rate with the currency, the rate as published, its quote such as GBP per EUR, USD 1.1130 per EUR, its rate_date and its rate_source, and amount is the figure it read, the upper end of a range with its lower end in amount_min, and rounded_to the place each dollar figure is rounded to, so every dollar figure is recomputed from these numbers alone. It is empty where the stored figure of one amount was read before this rule, until the figures are read again. A Value is also read where the sources state the money backing the deal, such as £129m will back the project or UKEF is providing £20m towards it. Where a row shows no Value although its summary states an amount, value_note says why, for example that the figure is a project or investment size.
Parties shows the first export credit agency, lender or exporter named so far and counts the rest. A description such as an international commercial bank names nobody and is not listed, two spellings of one company such as Ltd and Limited are one exporter, and an agency named only as EXIM is the export credit agency the source itself names in full. A stage of ECA cover needs a named export credit agency, and an unknown stage carries no confidence beyond low. Where a lender a source names is the only institution on the row, the angle names it with its kind, and the summary names that lender instead of calling the lender role open.
Score is the fit for your desk, from 0 to 100. The deal page lists every reason behind it. Its band word reads Strong fit from 70, Worth a look from 45, Weak fit from 20 and Not a fit below, and a deal whose market or sector is outside the mandate your team wrote down never reads Strong fit, whatever its score, while its mandate reason says which one.
Last activity is the date of the newest event a source confirmed. Where no source confirms an event date, it is the day the newest reported event was first published, so a later page that repeats an old report never makes the deal look new. Where the report itself states the day of its event in an earlier month, such as the signing date in an export credit agency's disclosure table, that day counts, written in words or in figures such as 20/02/2019, and a date in figures that reads two ways, such as 05/03/2019, counts for nothing. A search snippet or an index page never dates a deal. In the API this date is last_event_at. A page stamped with its year alone, 1 January, dates nothing, and where a report names the day of its event in a later month than the page that carries it, that day counts, since a page cannot report an event before it happened.

The order and the filters

The book runs in priority order. Open financings come first, then early stage deals, then deals no source has confirmed, with the highest score first inside each group. On a real estate desk the deals closest to a sale or a refinancing come first across these three groups, exchanged sales and refinancings, then deals under offer, then marketed ones, then the rest in the order above, because a sale's state is rarely confirmed by a quote. A deal whose financing is set or cancelled never rises above them, and every other desk's order is unchanged. Search and the stage, sector and region filters narrow the book. The search keeps the deals that show every word typed as a whole word, wherever each word stands, and a phrase in double quotes as written, so NIS finds the shekel code and never Ministry. A word counts where the row shows it, in the deal name, the buyer, the summary, an exporter or an agency under the name the row prints or another name the registry holds for it, never in a spelling a source reported that the row does not show. The stage filter offers the financing window words the list shows, so a chosen window lists only rows that read it, and under All teams the sector filter offers the sectors of every team's desk. The institution, country and status filters sit behind the Filters button, and its count says how many of them narrow the book. A book that holds no deal under the filters set names those filters and offers to clear them, and each page of the list has its own address, so Back returns to the page before. The Order field sits there too. It sorts the whole list by one column instead, highest, newest or furthest stage first and names from A to Z, and it never counts as a filter because it narrows nothing. Over the API, sort and direction choose the order in either direction.

What is held back

Some deals are held back from the book by default, and the page says how many. They are deals whose financing is set or cancelled, deals your own bank already lends to, domestic deals, deals whose last activity is older than the stale window of 12 months by default, deals without movement for 12 months, and deals valued below your team's value floor. A deal whose own summary says its financing closed or its cover was provided reads Financing set where no source quote has confirmed more than an announcement, its reason names the date that sentence states, and the summary never opens or advances a deal. A financing a source quote holds open, such as a tender, an award, a mandate, money being arranged or cover in principle, stays open whatever the summary says, because the quote is the source's own words and the summary is not. Where no event date is confirmed, a date the deal's own summary states counts for its age when it is older than the day the deal was published, read as late as its words allow, so 2025 counts as the end of 2025 and December 2025 as its last day, and the reason names it as written, for example No movement since 2010. A year alone counts only where the summary dates an event with it, such as in 2019, never in a name or a figure such as Natura 2000 or 2000 kW. A date a plan, a deadline, a range, a law or a background clause leads to counts for nothing, and the briefing is never read for a date. A Project Finance desk also holds back a works lot with no financing need, such as scaffolding, doors, landscaping or paving at a public building, with the reason Works contract, no financing need, while a works contract whose sources name a lender, a financing or a concession stays in its book. A real estate desk also holds back deals in a market outside its mandate, and deals that are not about property, such as an energy, industrial or infrastructure asset or the takeover of a company, and no new deal of that kind enters its book. One click shows them again. Over the API they come back with include_hidden=true, and each row says why with score_hidden and its ranking reasons.

Tuning the score

The Scoring page holds the rubric behind the score of the team chosen in the sidebar, one rubric per team. It tunes the five parts every score is the sum of, where each confirmed state stands, the evidence rungs and the demotions your desk's ranking reads. A weight runs from 0 to 100 and the weights sum to 100, a factor runs from 0 to 1, and a field outside its range is marked before anything is sent. Preview effect shows the deals the draft moves most across the whole book, each with its score and its place in this book under the draft, and Save and activate makes the draft live, after which the book reorders in the same order the preview showed. Built in default puts the team back on its desk's launch rubric, and every saved version stays in the list, one Activate away. A draft you leave unsaved is kept in that browser tab until you come back.

Parties, agencies and countries

Each party appears once on the deal page, in the API, over MCP, in the report and in Screen all parties, whatever spellings and roles its sources gave it. An acronym or ticker in brackets after a name and the name spelled out after its acronym name that company, and an agency under any of its registry names is that agency. A place or another company in brackets, a subsidiary, a joint venture or a consortium of a named company is a party of its own. An offtaker and a processing partner are listed under their own roles, never as buyers. An agency named only as EXIM is the export import bank its own mention names, US EXIM beside US words, else the one the source names in full. Where no source names an exporter or an EPC contractor, the parties say so. The German federal export credit guarantees read Hermes cover, the scheme Euler Hermes Aktiengesellschaft grants and handles on the mandate of the Federal Government, and KfW IPEX reads as itself, apart from KfW. A deal's country is one its own lines name, never another project's line in a list or a party's seat, and a deal with no structured country reads the places its own lines state. On Institutions an agency's deal count is the number of deals the Deal Book finds when filtered by that agency, in any role. Behind Filters, Institution involved lists ECA named and every institution of the registry with the number of deals naming it, several can be ticked at once, and a deal naming any of them stays, the same eca filter GET /v1/deals takes once per agency. A dollar figure converted from another currency names its rate, the day the rate is published for and its source, under Rate and source on the deal page and on hover in the list. A party the deal already holds matched to a register under the same name in another role is that party, so Match parties to a register and GET /v1/deals/parties/binding-queue do not list it again.

Project registers

A deal in the United Kingdom or the United States that builds generation or storage names the record of its project in the UK Renewable Energy Planning Database or the EIA 860M generator inventory, under Project register on the deal page and as project_records in GET /v1/deals/{deal_id} and the MCP tool deal_book. Each record shows the register's own status and the date of the first edition that shows it, for a US generator the planned operation month against the first one the register reported and how many months it moved, the month it went into operation, the capacity and the operator as the register states them, the edition with the day it was published and the date its data describes, and a link to the register's own file. Delayed marks a record the register reads as delayed beyond two quarters, or as canceled, abandoned, out of service or retired, the rule the portfolio's project signal reads too. A record links only where its name is the deal's project name, apart from the technology words and the deal's own sponsor, and its technology fits the deal, so two projects of one name, or a name that is only one phase of a larger project, link nothing.

Agency publications

The German federal export credit guarantees (Hermes cover) publish each Category A project no later than 30 days before the final decision on cover, and each project finally covered once its exporter agrees. Both pages are read as sources of the Deal Book for an export finance team that watches the agency. A Category A project opens a deal with Hermes cover as its agency, and a finally covered item joins a deal only where it names that deal's own party, country and assets, because the list names no buyer. Each entry is quoted with a link to its place on the page.

On a phone

On a narrow screen each deal reads as one block, its name in full on the first line and its stage, value, parties, score and last activity below it, so nothing is cut at the edge of the screen. The Portfolio, the screenings list and a company's officers and ownership read the same way.

Following and exporting

Point at a row for its two actions. Follow keeps the deal and lists it under the Following tab, newest update first. Where following adds a research check of its own, the hint of Follow on a deal page states how often that check runs. The Following tab lists the deals you follow, and only deals. How often a followed deal is checked, and pausing it, is set on Monitoring, where you also monitor companies, brands, persons and topics (Social monitoring). Dismiss asks for one reason and takes the deal off the book. For a deal of your workspace's own it also stops that deal's research, while a deal from the shared deal pool keeps the pool's research, which your dismissal does not affect. Either way a dismissed deal is suggested for reopening once when new evidence moves it on (a later stage, a value first at USD 200 million or more, or fresh coverage of a deal of your own set aside as historical), and it then shows under the Reopen suggested view; Reopen and follow on its page brings it back. A deal merged into another one, or dismissed by Stonewake in the shared deal pool, can be neither reopened nor followed, and its page says why. When Stonewake finds that two deals report one transaction and merges them, the deal that stays keeps your team's follow, dismissal and next step from the other one. Where the two differ, following comes first, then a dismissal, then an untriaged deal, so a deal you follow never leaves the Following tab through a merge. A dismissal as a duplicate or as historical carries nothing, and the deal that stays keeps its own next step, or takes the other one's where it has none. If Stonewake later splits the two again, what the merge carried goes back, unless your team changed it since. Update research on a deal page researches a deal of your workspace's own once, now, and changes no schedule. Export downloads the deals the page shows as an Excel workbook in the dashboard's language, its headers and fixed words in German when the dashboard reads German. Beside Reported value it carries the table's Value as numbers Excel sorts and totals, Value (USD) for one amount, Value from (USD) and Value to (USD) for a bound or a range, and Rate with the rate, its date and its source, or that the amount is stated in dollars. Download report on a deal page produces that deal as a PDF.

A deal's page offers Download report, the deal as a PDF, and Download deck, the deal as slides for a committee, built by fixed rules from stored data with no model step. GET /v1/deals/{deal_id}/deck.pptx serves the same deck to a key with the reports scope (see the API reference).