Deterministic company, entity and location lookups for agents - per call, x402 or API key.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Return the accounts filing status of a UK company from the Companies House register — the accounting reference date, the last accounts filed (type and period), the next accounts due date and a derived overdue flag. Use when: When are this UK company's accounts due? Not for: You need financial figures (turnover, profit, balance sheet) — not on the public register API. Related: company_uk_filings; company_uk_profile; company_uk_status. Price: USD 0.003/call (x402), 0.002 (account key).
Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call.
Return the accounts filing status of a UK company from the Companies House register — the accounting reference date, the last accounts filed (type and period), the next accounts due date and a derived overdue flag. Use when: When are this UK company's accounts due? Not for: You need financial figures (turnover, profit, balance sheet) — not on the public register API. Related: company_uk_filings; company_uk_profile; company_uk_status. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| company_number* | string | Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call. |
{
"type": "object",
"required": [
"company_number"
],
"properties": {
"company_number": {
"type": "string",
"pattern": "^\\s*(?:[0-9]{1,8}|[A-Za-z][0-9]{7}|[A-Za-z]{2}[0-9]{6}|[A-Za-z]{2}[0-9]{5}[A-Za-z]|[A-Za-z]{2}[0-9]{4}[A-Za-z]{2})\\s*$",
"maxLength": 10,
"minLength": 1,
"description": "Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call."
}
},
"additionalProperties": false
}Charges registered against a UK company at Companies House — mortgages, debentures and other security — with dates, classification, particulars and the persons entitled. Use when: Establish whether a UK company has outstanding security over its assets, and who holds it. Not for: You need insolvency proceedings — not currently supported (see the resource flags on company.uk.profile). Related: company_uk_profile; company_uk_filings; company_uk_status. Price: USD 0.006/call (x402), 0.005 (account key).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum charges to return per page (1-100). Default 3: a charge carries free-text particulars, secured details and the persons entitled, so it is several times the size of an officer or a filing row - the register-wide counts and page.total still describe the whole register. |
| detail | string | How much of each charge to return. Default summary. `full` adds the four members the register populates only for particular filings — acquired_on, resolved_on, assets_ceased_released and more_than_four_persons_entitled — which are null on the great majority of charges. |
| offset | integer | Zero-based index into the register's charge list (not into the filtered result). Pass back page.next_offset from the previous response to page. |
| status | string | Which charges to return. Default `all`. `outstanding` returns the charges that are still security over the company (everything the register has not marked satisfied or fully-satisfied, including part-satisfied); `satisfied` returns the discharged ones. The register offers no server-side filter, so Eckari applies it after reading up to three register pages of 100 charges — read page.has_more rather than items.length. |
Directors of a UK company from the Companies House officers register — the register of directors, secretaries and LLP members — including corporate and nominee directors, with appointment and resignation dates, nationality, country of residence, occupation, month/year of birth and correspondence address. Use when: Identify who is legally responsible for a UK company - the directors on the Companies House officers register. Not for: You need beneficial owners / persons with significant control — use company.uk.owners. Price: USD 0.005/call (x402), 0.004 (account key).
| Argument | Type | Description |
|---|---|---|
| role | string | Which appointments to return. Default `director` — the capability's name is its contract. The register encodes the office in officer_role, so the filter is a substring test on it: `director` matches director, corporate-director, nominee-director and corporate-nominee-director; `secretary` matches secretary, corporate-secretary, nominee-secretary and corporate-nominee-secretary; `llp_member` matches llp-member, llp-designated-member and their corporate- forms; `all` returns every appointment the register lists, including managing officers, general partners, judicial factors and the EEIG/SE organ roles. Filtering is applied after the register read, so read page.has_more rather than items.length. |
| limit | integer | Maximum officers to return per page (1-100). Default 5. Eckari reads up to three register pages of 100 entries to fill this after the role and resigned filters are applied; if the limit is still unmet, page.has_more is true and page.next_offset says where to resume. |
| offset | integer | Zero-based index into the register's own officer list (not into the filtered result). Pass back page.next_offset from the previous response to page. |
Return the filing history of a UK company from the Companies House register — accounts, confirmation statements, officer appointments, address and capital changes, resolutions and mortgages — most recent first, optionally filtered by category, with date, form type (AA, CS01, AP01, TM01), the readable register description, registrar annotations and a document_url for every filed image. Use when: What has this UK company filed recently? Not for: You need the current directors themselves rather than the filing events — use company.uk.directors. Price: USD 0.005/call (x402), 0.004 (account key).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum filings to return per page (1-100). Default 5. |
| detail | string | How much of each filing to return. Default summary: the readable description, its source, the register's annotations, the form type and the document URL. `full` adds the register's raw description_key and description_values for reconciliation against a register capture. |
| offset | integer | Zero-based index into the register's filing list for the applied category filter. Nothing is filtered out after reading, so page.has_more is simply offset + returned < page.total; pass back page.next_offset. |
| category | string | Optional comma-separated register categories to include (e.g. accounts, address, annual-return, capital, change-of-name, incorporation, liquidation, miscellaneous, mortgage, officers, resolution, confirmation-statement). The applied value is echoed back as query.category. |
| company_number |
An empty items list is never the same as "no owner": ownership_status and the filed PSC statements/exemptions explain why the register discloses none. Use when: Who owns this UK company? Not for: You need directors/officers rather than owners — use company.uk.directors. Related: company_uk_directors; company_uk_profile; company_uk_status. Price: USD 0.008/call (x402), 0.006 (account key).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum PSCs to return per page (1-100). Default 10. Eckari reads up to three register pages of 100 entries to fill this after the ceased filter is applied; if the limit is still unmet, page.has_more is true and page.next_offset says where to resume. |
| offset | integer | Zero-based index into the register's own PSC list (not into the filtered result). Pass back page.next_offset from the previous response to page. |
| company_number* | string | Companies House company number. Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call. |
| include_ceased | boolean | Include PSCs whose control has ceased. Default false. |
Return the core registered profile of a UK company from the Companies House register: name, status with derived is_active and is_striking_off, type, jurisdiction, incorporation and cessation dates, SIC codes with their official UK SIC 2007 descriptions, registered office address, previous names, and the accounts and confirmation-statement summary. Use when: You have a UK company number and need the standard registered record. Not for: You only need to know if the company is active — use company.uk.status (cheaper). Price: USD 0.004/call (x402), 0.003 (account key).
| Argument | Type | Description |
|---|---|---|
| company_number* | string | Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call. |
{
"type": "object",
"required": [
"company_number"
],
"properties": {
"company_number": {
"type": "string",
"pattern": "^\\s*(?:[0-9]{1,8}|[A-Za-z][0-9]{7}|[A-Za-z]{2}[0-9]{6}|[A-Za-z]{2}[0-9]{5}[A-Za-z]|[A-Za-z]{2}[0-9]{4}[A-Za-z]{2})\\s*$",
"maxLength": 10,
"minLength": 1,
"description": "Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call."
}
},
"additionalProperties": false
}Return the current registered office address of a UK company from the Companies House register as structured fields (premises, address lines, locality, region, postcode, country) plus a single-line rendering for correspondence, address matching and verification. Use when: What is the registered office address of company 00445790? Not for: You need the whole registered profile as well — use company.uk.profile (it already includes this address). Related: company_uk_profile; company_uk_status; company_uk_search. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| company_number* | string | Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call. |
{
"type": "object",
"required": [
"company_number"
],
"properties": {
"company_number": {
"type": "string",
"pattern": "^\\s*(?:[0-9]{1,8}|[A-Za-z][0-9]{7}|[A-Za-z]{2}[0-9]{6}|[A-Za-z]{2}[0-9]{5}[A-Za-z]|[A-Za-z]{2}[0-9]{4}[A-Za-z]{2})\\s*$",
"maxLength": 10,
"minLength": 1,
"description": "Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call."
}
},
"additionalProperties": false
}Search the UK Companies House register by name or keyword and return matching companies with company number, register status and a derived is_active, type, incorporation and cessation dates and the register's one-line address snippet. Use when: Look up a UK company by name. Not for: You already have the company number — call company.uk.profile or company.uk.status directly. Related: company_uk_status; company_uk_profile; company_uk_directors; company_uk_owners. Price: USD 0.002/call (x402), 0.0015 (account key).
| Argument | Type | Description |
|---|---|---|
| q* | string | Company name or keyword to search for. |
| limit | integer | Maximum results to return (1-50). Default 10. |
| offset | integer | Zero-based offset into the register's result set for paging. Pass back page.next_offset from the previous response; page.has_more says whether there is one. |
{
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"minLength": 2,
"description": "Company name or keyword to search for."
},
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Maximum results to return (1-50). Default 10."
},
"offset": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Zero-based offset into the register's result set for paging. Pass back page.next_offset from the previous response; page.has_more says whether there is one."
}
},
"additionalProperties": false
}Return the current legal status of a UK company from the Companies House register — active, dissolved, liquidation, administration, receivership, voluntary-arrangement and others — with status detail, cessation date, a derived is_active (true for the live-on-the-register statuses active, open and registered) and a derived is_striking_off for an active company with a proposal to strike off. Use when: Is this UK company still active? Not for: You need the full registered profile (type, SIC codes, incorporation date) — use company.uk.profile. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| company_number* | string | Companies House company number, also called the company registration number (CRN), e.g. 00445790, SC123456, NI000001, BR008975. Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call. |
{
"type": "object",
"required": [
"company_number"
],
"properties": {
"company_number": {
"type": "string",
"pattern": "^\\s*(?:[0-9]{1,8}|[A-Za-z][0-9]{7}|[A-Za-z]{2}[0-9]{6}|[A-Za-z]{2}[0-9]{5}[A-Za-z]|[A-Za-z]{2}[0-9]{4}[A-Za-z]{2})\\s*$",
"maxLength": 10,
"minLength": 1,
"description": "Companies House company number, also called the company registration number (CRN), e.g. 00445790, SC123456, NI000001, BR008975. Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call."
}
},
"additionalProperties": false
}Return the recent EDGAR filing history of a US company identified by stock ticker (AAPL) or CIK, optionally filtered by form type and filing date and paged. Use when: List every 8-K on this ticker's EDGAR index this year, with links to the documents. Not for: You need to know who submitted a filing — EDGAR's submissions index carries no filer identity, so a Form 4 or SCHEDULE 13G here tells you the filing exists, not who made it. Related: company_us_filings_latest; company_us_profile; company_us_resolve; company_uk_filings. Price: USD 0.005/call (x402), 0.004 (account key).
| Argument | Type | Description |
|---|---|---|
| id* | string | SEC CIK or exchange ticker symbol. All digits is read as a CIK (leading zeros and an EDGAR CIK prefix are both accepted: 320193, 0000320193, CIK0000320193); anything else is read as a ticker (1-10 characters starting with a letter) and matched exactly, case-insensitively, against the SEC listed-security index — AAPL, aapl and BRK-B all work. Company names are not accepted: resolve one with company.us.resolve. A ticker with no SEC index entry returns NOT_FOUND, which is not a billable result. |
| form | string | Comma-separated EDGAR form types to keep, e.g. "10-K,10-Q,8-K". Matching is exact and case-insensitive; omit to return every form. |
| limit | integer | Maximum number of filings to return from the filtered set. Defaults to 5 so a first call stays small; raise it explicitly when you need more. |
| since | string | Keep only filings with a filing_date on or after this ISO date (YYYY-MM-DD). |
Give a stock ticker (AAPL) or CIK and get the most recent EDGAR filing of each requested form — by default the latest 10-K, 10-Q and 8-K — with filing and report dates and a direct sec.gov link to each primary document. Use when: What is Apple's latest 8-K, and where is the document? Not for: You need to know who submitted the filing — EDGAR's submissions index carries no filer identity, and for ownership forms (3, 4, 5, SCHEDULE 13G) the submitter is a third party, not the company. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| id* | string | SEC CIK or exchange ticker symbol. All digits is read as a CIK (leading zeros and an EDGAR CIK prefix are both accepted: 320193, 0000320193, CIK0000320193); anything else is read as a ticker (1-10 characters starting with a letter) and matched exactly, case-insensitively, against the SEC listed-security index — AAPL, aapl and BRK-B all work. Company names are not accepted: resolve one with company.us.resolve. A ticker with no SEC index entry returns NOT_FOUND, which is not a billable result. |
| form | string | Comma-separated EDGAR form types to report the latest filing of. Defaults to "10-K,10-Q,8-K". Matching is exact and case-insensitive; output order follows the requested order. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^(?:(?:[Cc][Ii][Kk])?[0-9]{1,10}|[A-Za-z][A-Za-z0-9.-]{0,9})$",
"maxLength": 13,
"minLength": 1,
"description": "SEC CIK or exchange ticker symbol. All digits is read as a CIK (leading zeros and an EDGAR CIK prefix are both accepted: 320193, 0000320193, CIK0000320193); anything else is read as a ticker (1-10 characters starting with a letter) and matched exactly, case-insensitively, against the SEC listed-security index — AAPL, aapl and BRK-B all work. Company names are not accepted: resolve one with company.us.resolve. A ticker with no SEC index entry returns NOT_FOUND, which is not a billable result."
},
"form": {
"type": "string",
"default": "10-K,10-Q,8-K",
"pattern": "^[A-Za-z0-9 ,/.-]+$",
"maxLength": 200,
"description": "Comma-separated EDGAR form types to report the latest filing of. Defaults to \"10-K,10-Q,8-K\". Matching is exact and case-insensitive; output order follows the requested order."
}
},
"additionalProperties": false
}Look up an SEC filer by stock ticker (AAPL) or CIK and return its registered profile — legal name, entity type, SIC industry code and description, EIN, filer category, fiscal year end, state of incorporation, tickers and exchanges, former names, business and mailing addresses and phone. Use when: Which exchanges and tickers does this filer trade under? Not for: You need to know whether the filer is still submitting periodic reports — check the filing dates with company.us.filings.latest; EDGAR publishes no reporting-status field. Price: USD 0.004/call (x402), 0.003 (account key).
| Argument | Type | Description |
|---|---|---|
| id* | string | SEC CIK or exchange ticker symbol. All digits is read as a CIK (leading zeros and an EDGAR CIK prefix are both accepted: 320193, 0000320193, CIK0000320193); anything else is read as a ticker (1-10 characters starting with a letter) and matched exactly, case-insensitively, against the SEC listed-security index — AAPL, aapl and BRK-B all work. Company names are not accepted: resolve one with company.us.resolve. A ticker with no SEC index entry returns NOT_FOUND, which is not a billable result. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^(?:(?:[Cc][Ii][Kk])?[0-9]{1,10}|[A-Za-z][A-Za-z0-9.-]{0,9})$",
"maxLength": 13,
"minLength": 1,
"description": "SEC CIK or exchange ticker symbol. All digits is read as a CIK (leading zeros and an EDGAR CIK prefix are both accepted: 320193, 0000320193, CIK0000320193); anything else is read as a ticker (1-10 characters starting with a letter) and matched exactly, case-insensitively, against the SEC listed-security index — AAPL, aapl and BRK-B all work. Company names are not accepted: resolve one with company.us.resolve. A ticker with no SEC index entry returns NOT_FOUND, which is not a billable result."
}
},
"additionalProperties": false
}Turn a company-name fragment or stock ticker into the SEC EDGAR identifiers. Use when: Which SEC filer and CIK does the company name "Apple" belong to? Not for: You already have a ticker or a CIK and want profile or filings — company.us.profile, company.us.filings and company.us.filings.latest accept either identifier directly, so this extra call is unnecessary. Related: company_us_profile; company_us_filings_latest; company_us_filings; entity_lei_search. Price: USD 0.002/call (x402), 0.0015 (account key).
| Argument | Type | Description |
|---|---|---|
| q* | string | Ticker symbol (e.g. AAPL) or company-name fragment (e.g. Apple). Matching is case-insensitive and trimmed; no fuzzy matching is applied. |
| limit | integer | Maximum number of ranked matches to return. Ranking is applied before the limit; page.total reports how many matched in full. |
{
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Ticker symbol (e.g. AAPL) or company-name fragment (e.g. Apple). Matching is case-insensitive and trimmed; no fuzzy matching is applied."
},
"limit": {
"type": "integer",
"default": 10,
"maximum": 25,
"minimum": 1,
"description": "Maximum number of ranked matches to return. Ranking is applied before the limit; page.total reports how many matched in full."
}
},
"additionalProperties": false
}Registry expiry date for a domain read live from the authoritative registry RDAP server, with whole days remaining, the registry status codes, the registrar name and the registry's own last-update timestamp. A focused, cheaper subset of domain.registration for renewal monitoring and portfolio checks. Use when: When does this domain expire? Not for: You also need nameservers, DNSSEC, the creation date or the registrar's abuse contact - use domain.registration. Related: domain_registration. Price: USD 0.002/call (x402), 0.0015 (account key).
| Argument | Type | Description |
|---|---|---|
| domain* | string | Bare domain name such as example.com or bbc.co.uk. Internationalised names are converted to punycode (IDNA). URLs, paths, ports and single-label names are rejected. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"pattern": "^[^ /:?#@]{3,253}$",
"maxLength": 253,
"minLength": 3,
"description": "Bare domain name such as example.com or bbc.co.uk. Internationalised names are converted to punycode (IDNA). URLs, paths, ports and single-label names are rejected."
}
},
"additionalProperties": false
}The WHOIS lookup for a domain, answered from the registry's own RDAP service - the structured successor to port-43 WHOIS, read live via the IANA bootstrap, never scraped WHOIS text. Use when: Answer a WHOIS question about a domain - registrar, creation date, expiry, transfer lock - from the registry record. Not for: You only need the expiry date and days remaining - use domain.expiry (cheaper). Related: domain_expiry. Price: USD 0.004/call (x402), 0.003 (account key).
| Argument | Type | Description |
|---|---|---|
| domain* | string | Bare domain name such as example.com or bbc.co.uk. Internationalised names are converted to punycode (IDNA). URLs, paths, ports and single-label names are rejected. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"pattern": "^[^ /:?#@]{3,253}$",
"maxLength": 253,
"minLength": 3,
"description": "Bare domain name such as example.com or bbc.co.uk. Internationalised names are converted to punycode (IDNA). URLs, paths, ports and single-label names are rejected."
}
},
"additionalProperties": false
}Return the registry-authoritative GLEIF record for a Legal Entity Identifier — legal and previous names, legal and headquarters addresses, jurisdiction, legal form, entity and registration status, renewal dates (with days until renewal), managing LOU, corroboration level, BIC codes and the named local registry. Use when: Look up everything the LEI register holds for this identifier. Not for: You only have a company name — use entity.lei.search first. Related: entity_lei_search; company_uk_profile; company_uk_status; company_us_profile. Price: USD 0.004/call (x402), 0.003 (account key).
| Argument | Type | Description |
|---|---|---|
| lei* | string | 20-character ISO 17442 Legal Entity Identifier (18 alphanumerics + 2 check digits). Case-insensitive. The structure is checked before payment, so a wrong-shaped LEI is rejected on the 402 (details.input_validation). The ISO 7064 MOD 97-10 checksum cannot be expressed as a schema pattern and is verified at execution: it fails with INVALID_INPUT before any upstream call and before settlement, so a bad checksum is never charged for. |
{
"type": "object",
"required": [
"lei"
],
"properties": {
"lei": {
"type": "string",
"pattern": "^[A-Za-z0-9]{18}[0-9]{2}$",
"maxLength": 20,
"minLength": 20,
"description": "20-character ISO 17442 Legal Entity Identifier (18 alphanumerics + 2 check digits). Case-insensitive. The structure is checked before payment, so a wrong-shaped LEI is rejected on the 402 (details.input_validation). The ISO 7064 MOD 97-10 checksum cannot be expressed as a schema pattern and is verified at execution: it fails with INVALID_INPUT before any upstream call and before settlement, so a bad checksum is never charged for."
}
},
"additionalProperties": false
}Find Legal Entity Identifiers by company name in the global GLEIF register, optionally narrowed to one country. Returns the LEI, legal name, registration and entity status, jurisdiction, legal address and the local registry the entity is registered at — the identifier bridge between national company registers worldwide. Use when: What is the LEI for this company? Not for: You already have the LEI — use entity.lei.profile. Related: entity_lei_profile; company_uk_search; company_us_resolve. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| q* | string | Legal entity name or name fragment. GLEIF applies its own matching to this value; Eckari does not re-rank the results. |
| limit | integer | Maximum number of entities to return. Capped at 25 because that is the most records one fuzzy-completion fill-in pass can hydrate; a larger page could not be filled and would misreport how much GLEIF holds. |
| offset | integer | Zero-based offset into the result set for paging. Pass back page.next_offset from the previous response; page.has_more says whether there is one. GLEIF pages by page number, so an offset that is a multiple of limit is one upstream page - which is every offset page.next_offset produces. Capped at 9900 because GLEIF refuses page-based pagination beyond 10,000 records; beyond that, narrow the query. |
| country | string | ISO 3166-1 alpha-2 country code of the entity's legal address, used to narrow the search (e.g. GB, US, DE). |
European Central Bank euro foreign exchange reference rate for a pair - the official daily fix used for accounting, invoicing and reporting - latest or any date in the last 90 days. The ECB publishes EUR/XXX only, so inverse and cross rates are computed from the same fix and named in rate_derivation. Use when: Convert or report an amount at an official daily rate both sides of a contract can verify against the ECB. Not for: You need an executable, tradable, live or intraday market rate - this is a daily fix only. Price: USD 0.002/call (x402), 0.0015 (account key).
| Argument | Type | Description |
|---|---|---|
| base* | string | ISO 4217 code of the base currency. EUR is always available; other currencies must be in the ECB reference rate list for the selected date. |
| date | string | Optional ISO calendar date (YYYY-MM-DD) within the last 90 days. When the ECB published no fix on that date (a TARGET closing day), the latest prior fix is returned with a note. |
| quote* | string | ISO 4217 code of the quote currency. EUR is always available; other currencies must be in the ECB reference rate list for the selected date. |
{
"type": "object",
"required": [
"base",
"quote"
],
"properties": {
"base": {
"type": "string",
"pattern": "^[A-Za-z]{3}$",
"description": "ISO 4217 code of the base currency. EUR is always available; other currencies must be in the ECB reference rate list for the selected date."
},
"date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
"description": "Optional ISO calendar date (YYYY-MM-DD) within the last 90 days. When the ECB published no fix on that date (a TARGET closing day), the latest prior fix is returned with a note."
},
"quote": {
"type": "string",
"pattern": "^[A-Za-z]{3}$",
"description": "ISO 4217 code of the quote currency. EUR is always available; other currencies must be in the ECB reference rate list for the selected date."
}
},
"additionalProperties": false
}Convert a one-line US street address into coordinates using the US Census Bureau Geocoder. Returns the standardised matched address, latitude and longitude to 6 decimal places, the TIGER/Line segment and parsed address components. Coordinates are interpolated along street address ranges, not rooftop or parcel positions. Use when: Convert this US street address to latitude and longitude. Not for: You need rooftop or parcel-level precision — Census coordinates are TIGER address-range interpolations. Related: location_us_geographies. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of candidate matches to return, in the Census Bureau's own order. page.total always reports how many the Census Bureau returned in total, so a low limit never hides an ambiguous address. |
| offset | integer | Zero-based index of the first candidate to return. The Census Bureau returns every match in one response, so paging is applied by Eckari over that set - pass page.next_offset to walk the remaining candidates without a second upstream lookup. |
| address* | string | One-line US street address including city and state, e.g. "1600 Pennsylvania Ave NW, Washington, DC 20500". |
{
"type": "object",
"required": [
"address"
],
"properties": {
"limit": {
"type": "integer",
"default": 5,
"maximum": 10,
"minimum": 1,
"description": "Maximum number of candidate matches to return, in the Census Bureau's own order. page.total always reports how many the Census Bureau returned in total, so a low limit never hides an ambiguous address."
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Zero-based index of the first candidate to return. The Census Bureau returns every match in one response, so paging is applied by Eckari over that set - pass page.next_offset to walk the remaining candidates without a second upstream lookup."
},
"address": {
"type": "string",
"maxLength": 200,
"minLength": 5,
"description": "One-line US street address including city and state, e.g. \"1600 Pennsylvania Ave NW, Washington, DC 20500\"."
}
},
"additionalProperties": false
}Return the US Census Bureau geographies containing a latitude/longitude — state, county, census tract, block group, census block, incorporated place, congressional district and ZIP Code Tabulation Area — each with its FIPS or GEOID. The standard way to attach official US statistical geography to a point. Use when: Which county and census tract is this coordinate in? Not for: You have an address rather than coordinates — use location.us.geocode first. Related: location_us_geocode. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| lat* | number | Latitude in decimal degrees (WGS 84), e.g. 38.8977. |
| lon* | number | Longitude in decimal degrees (WGS 84), negative in the western hemisphere, e.g. -77.0365. |
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude in decimal degrees (WGS 84), e.g. 38.8977."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude in decimal degrees (WGS 84), negative in the western hemisphere, e.g. -77.0365."
}
},
"additionalProperties": false
}Identify which carrier issued a tracking number using a deterministic, versioned signature set - prefixes, lengths, carrier check digits and UPU S10 structure - returning the carrier, how distinctive the match is, every ranked candidate with typed evidence, and the parsed S10 details. No upstream call and no carrier account required. Use when: Which carrier is this tracking number from? Not for: You need tracking events, status or delivery estimates - not yet available. Price: USD 0.001/call (x402), 0.001 (account key).
| Argument | Type | Description |
|---|---|---|
| origin_country | string | Optional ISO 3166-1 alpha-2 origin country hint. Used only as a small tie-breaker; it never invents a candidate. |
| tracking_number* | string | Tracking or consignment number. Spaces and hyphens are removed and letters upper-cased before matching (4-40 letters and digits after normalisation). Digits and letters are never altered. |
| destination_country | string | Optional ISO 3166-1 alpha-2 destination country hint. Used only as a small tie-breaker; it never invents a candidate. |
{
"type": "object",
"required": [
"tracking_number"
],
"properties": {
"origin_country": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Optional ISO 3166-1 alpha-2 origin country hint. Used only as a small tie-breaker; it never invents a candidate."
},
"tracking_number": {
"type": "string",
"pattern": "^[A-Za-z0-9 -]+$",
"maxLength": 60,
"minLength": 4,
"description": "Tracking or consignment number. Spaces and hyphens are removed and letters upper-cased before matching (4-40 letters and digits after normalisation). Digits and letters are never altered."
},
"destination_country": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Optional ISO 3166-1 alpha-2 destination country hint. Used only as a small tie-breaker; it never invents a candidate."
}
},
"additionalProperties": false
}Active National Weather Service watches, warnings and advisories for a US coordinate or a two-letter state or marine area code - event, severity, certainty, urgency, headline, affected areas and zone codes, and effective/onset/expiry times in UTC. Read at request time, so an empty list means nothing is active. Use when: Decide whether an active US weather warning affects a location before dispatching or travelling. Not for: You need the forecast rather than alerts - use weather.us.forecast. Related: weather_us_forecast; weather_us_observation. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| lat | number | Latitude in decimal degrees (WGS84). Provide lat and lon together, or provide state. |
| lon | number | Longitude in decimal degrees (WGS84). Provide lat and lon together, or provide state. |
| limit | integer | Maximum number of active alerts to return, in the order NWS returns them. The default of 5 keeps the answer compact - a busy state can have dozens of active alerts, each covering tens of zones - and page.total always reports how many are active, so nothing is hidden. |
| state | string | Two-letter US state, territory or NWS marine area code such as CA / TX / PR. Alternative to lat and lon; one of the two forms is required. |
| detail | string | compact (default) returns the fields an agent decides on. full adds the two NWS narrative members - description (the multi-paragraph WHAT/WHERE/WHEN/IMPACTS text, truncated at 2000 characters with description_truncated set) and instruction (the protective-action text) - which are written for a human reader and are several times the size of the rest of the alert. |
Official National Weather Service forecast for any US coordinate - six 12-hour day/night periods by default, or hourly - each with temperature in C and F, precipitation probability, a wind speed range in km/h, wind direction and a short forecast, plus the NWS issue time so an agent can judge its age. Use when: What is the weather forecast for these US coordinates? Not for: You need the latest observed conditions and their age - use weather.us.observation. Related: weather_us_observation; weather_us_alerts. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| lat* | number | Latitude in decimal degrees (WGS84). Rounded to 4 decimal places before the National Weather Service lookup. |
| lon* | number | Longitude in decimal degrees (WGS84). Rounded to 4 decimal places before the National Weather Service lookup. |
| hours | integer | Number of hourly periods to return, soonest first. Applies when hourly is true; use period_limit for day/night forecasts. |
| detail | string | compact (default) returns the fields an agent acts on. full adds the NWS narrative (detailed_forecast), the icon URL, the trend note and, for hourly periods, dewpoint_c and humidity_pct. |
| hourly | boolean | Return hourly periods instead of the default 12-hour day/night periods. Hourly periods have no name and, at detail=full, carry dewpoint and humidity. |
Latest surface observation from the nearest National Weather Service station to a US coordinate, with the station identity, the observation time (observed_at), its age in seconds and an is_stale flag. Station observations are reported roughly every 20-60 minutes, so this is the most recent measurement, not a real-time reading. Use when: What was the most recently observed temperature at these US coordinates? Not for: You need a prediction rather than a measurement - use weather.us.forecast. Related: weather_us_forecast; weather_us_alerts. Price: USD 0.003/call (x402), 0.002 (account key).
| Argument | Type | Description |
|---|---|---|
| lat* | number | Latitude in decimal degrees (WGS84). Rounded to 4 decimal places before the National Weather Service lookup. |
| lon* | number | Longitude in decimal degrees (WGS84). Rounded to 4 decimal places before the National Weather Service lookup. |
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude in decimal degrees (WGS84). Rounded to 4 decimal places before the National Weather Service lookup."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude in decimal degrees (WGS84). Rounded to 4 decimal places before the National Weather Service lookup."
}
},
"additionalProperties": false
}| company_number* | string | Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call. |
{
"type": "object",
"required": [
"company_number"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum charges to return per page (1-100). Default 3: a charge carries free-text particulars, secured details and the persons entitled, so it is several times the size of an officer or a filing row - the register-wide counts and page.total still describe the whole register."
},
"detail": {
"enum": [
"summary",
"full"
],
"type": "string",
"description": "How much of each charge to return. Default summary. `full` adds the four members the register populates only for particular filings — acquired_on, resolved_on, assets_ceased_released and more_than_four_persons_entitled — which are null on the great majority of charges."
},
"offset": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Zero-based index into the register's charge list (not into the filtered result). Pass back page.next_offset from the previous response to page."
},
"status": {
"enum": [
"outstanding",
"satisfied",
"all"
],
"type": "string",
"description": "Which charges to return. Default `all`. `outstanding` returns the charges that are still security over the company (everything the register has not marked satisfied or fully-satisfied, including part-satisfied); `satisfied` returns the discharged ones. The register offers no server-side filter, so Eckari applies it after reading up to three register pages of 100 charges — read page.has_more rather than items.length."
},
"company_number": {
"type": "string",
"pattern": "^\\s*(?:[0-9]{1,8}|[A-Za-z][0-9]{7}|[A-Za-z]{2}[0-9]{6}|[A-Za-z]{2}[0-9]{5}[A-Za-z]|[A-Za-z]{2}[0-9]{4}[A-Za-z]{2})\\s*$",
"maxLength": 10,
"minLength": 1,
"description": "Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call."
}
},
"additionalProperties": false
}| company_number* | string | Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call. |
| include_resigned | boolean | Include resigned officers. Default false. |
{
"type": "object",
"required": [
"company_number"
],
"properties": {
"role": {
"enum": [
"director",
"secretary",
"llp_member",
"all"
],
"type": "string",
"description": "Which appointments to return. Default `director` — the capability's name is its contract. The register encodes the office in officer_role, so the filter is a substring test on it: `director` matches director, corporate-director, nominee-director and corporate-nominee-director; `secretary` matches secretary, corporate-secretary, nominee-secretary and corporate-nominee-secretary; `llp_member` matches llp-member, llp-designated-member and their corporate- forms; `all` returns every appointment the register lists, including managing officers, general partners, judicial factors and the EEIG/SE organ roles. Filtering is applied after the register read, so read page.has_more rather than items.length."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum officers to return per page (1-100). Default 5. Eckari reads up to three register pages of 100 entries to fill this after the role and resigned filters are applied; if the limit is still unmet, page.has_more is true and page.next_offset says where to resume."
},
"offset": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Zero-based index into the register's own officer list (not into the filtered result). Pass back page.next_offset from the previous response to page."
},
"company_number": {
"type": "string",
"pattern": "^\\s*(?:[0-9]{1,8}|[A-Za-z][0-9]{7}|[A-Za-z]{2}[0-9]{6}|[A-Za-z]{2}[0-9]{5}[A-Za-z]|[A-Za-z]{2}[0-9]{4}[A-Za-z]{2})\\s*$",
"maxLength": 10,
"minLength": 1,
"description": "Companies House company number, also called the company registration number (CRN). Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call."
},
"include_resigned": {
"type": "boolean",
"description": "Include resigned officers. Default false."
}
},
"additionalProperties": false
}| string |
| Companies House company number. Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call. |
{
"type": "object",
"required": [
"company_number"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum filings to return per page (1-100). Default 5."
},
"detail": {
"enum": [
"summary",
"full"
],
"type": "string",
"description": "How much of each filing to return. Default summary: the readable description, its source, the register's annotations, the form type and the document URL. `full` adds the register's raw description_key and description_values for reconciliation against a register capture."
},
"offset": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Zero-based index into the register's filing list for the applied category filter. Nothing is filtered out after reading, so page.has_more is simply offset + returned < page.total; pass back page.next_offset."
},
"category": {
"type": "string",
"pattern": "^[a-z-]+(,[a-z-]+)*$",
"maxLength": 200,
"description": "Optional comma-separated register categories to include (e.g. accounts, address, annual-return, capital, change-of-name, incorporation, liquidation, miscellaneous, mortgage, officers, resolution, confirmation-statement). The applied value is echoed back as query.category."
},
"company_number": {
"type": "string",
"pattern": "^\\s*(?:[0-9]{1,8}|[A-Za-z][0-9]{7}|[A-Za-z]{2}[0-9]{6}|[A-Za-z]{2}[0-9]{5}[A-Za-z]|[A-Za-z]{2}[0-9]{4}[A-Za-z]{2})\\s*$",
"maxLength": 10,
"minLength": 1,
"description": "Companies House company number. Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"company_number"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum PSCs to return per page (1-100). Default 10. Eckari reads up to three register pages of 100 entries to fill this after the ceased filter is applied; if the limit is still unmet, page.has_more is true and page.next_offset says where to resume."
},
"offset": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Zero-based index into the register's own PSC list (not into the filtered result). Pass back page.next_offset from the previous response to page."
},
"company_number": {
"type": "string",
"pattern": "^\\s*(?:[0-9]{1,8}|[A-Za-z][0-9]{7}|[A-Za-z]{2}[0-9]{6}|[A-Za-z]{2}[0-9]{5}[A-Za-z]|[A-Za-z]{2}[0-9]{4}[A-Za-z]{2})\\s*$",
"maxLength": 10,
"minLength": 1,
"description": "Companies House company number. Accepted shapes are the register's own — 1-8 digits (zero-padded to 8, e.g. 445790 → 00445790), one letter + 7 digits (R0000001), two letters + 6 digits (SC002180, NI000001, OC123456, OE000001), or the registered-society suffix forms (two letters + 5 digits + 1 letter; two letters + 4 digits + 2 letters). Case-insensitive; surrounding whitespace is ignored (which is why maxLength is 10); internal spaces and punctuation are not accepted. Any other value (for example PROBE) is rejected as INVALID_INPUT before payment and before any upstream call."
},
"include_ceased": {
"type": "boolean",
"description": "Include PSCs whose control has ceased. Default false."
}
},
"additionalProperties": false
}| offset |
| integer |
| Zero-based offset into the filtered set, for paging. Pass page.next_offset from the previous response. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^(?:(?:[Cc][Ii][Kk])?[0-9]{1,10}|[A-Za-z][A-Za-z0-9.-]{0,9})$",
"maxLength": 13,
"minLength": 1,
"description": "SEC CIK or exchange ticker symbol. All digits is read as a CIK (leading zeros and an EDGAR CIK prefix are both accepted: 320193, 0000320193, CIK0000320193); anything else is read as a ticker (1-10 characters starting with a letter) and matched exactly, case-insensitively, against the SEC listed-security index — AAPL, aapl and BRK-B all work. Company names are not accepted: resolve one with company.us.resolve. A ticker with no SEC index entry returns NOT_FOUND, which is not a billable result."
},
"form": {
"type": "string",
"pattern": "^[A-Za-z0-9 ,/.-]+$",
"maxLength": 200,
"description": "Comma-separated EDGAR form types to keep, e.g. \"10-K,10-Q,8-K\". Matching is exact and case-insensitive; omit to return every form."
},
"limit": {
"type": "integer",
"default": 5,
"maximum": 100,
"minimum": 1,
"description": "Maximum number of filings to return from the filtered set. Defaults to 5 so a first call stays small; raise it explicitly when you need more."
},
"since": {
"type": "string",
"format": "date",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
"description": "Keep only filings with a filing_date on or after this ISO date (YYYY-MM-DD)."
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Zero-based offset into the filtered set, for paging. Pass page.next_offset from the previous response."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"minLength": 2,
"description": "Legal entity name or name fragment. GLEIF applies its own matching to this value; Eckari does not re-rank the results."
},
"limit": {
"type": "integer",
"default": 10,
"maximum": 25,
"minimum": 1,
"description": "Maximum number of entities to return. Capped at 25 because that is the most records one fuzzy-completion fill-in pass can hydrate; a larger page could not be filled and would misreport how much GLEIF holds."
},
"offset": {
"type": "integer",
"maximum": 9900,
"minimum": 0,
"description": "Zero-based offset into the result set for paging. Pass back page.next_offset from the previous response; page.has_more says whether there is one. GLEIF pages by page number, so an offset that is a multiple of limit is one upstream page - which is every offset page.next_offset produces. Capped at 9900 because GLEIF refuses page-based pagination beyond 10,000 records; beyond that, narrow the query."
},
"country": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "ISO 3166-1 alpha-2 country code of the entity's legal address, used to narrow the search (e.g. GB, US, DE)."
}
},
"additionalProperties": false
}| offset | integer | Zero-based index of the first alert to return, for paging through the active set with limit. The whole active set is read in one upstream request and returned in that order, so a window over it is consistent. |
{
"type": "object",
"anyOf": [
{
"required": [
"lat",
"lon"
]
},
{
"required": [
"state"
]
}
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude in decimal degrees (WGS84). Provide lat and lon together, or provide state."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude in decimal degrees (WGS84). Provide lat and lon together, or provide state."
},
"limit": {
"type": "integer",
"default": 5,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of active alerts to return, in the order NWS returns them. The default of 5 keeps the answer compact - a busy state can have dozens of active alerts, each covering tens of zones - and page.total always reports how many are active, so nothing is hidden."
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter US state, territory or NWS marine area code such as CA / TX / PR. Alternative to lat and lon; one of the two forms is required."
},
"detail": {
"enum": [
"compact",
"full"
],
"type": "string",
"default": "compact",
"description": "compact (default) returns the fields an agent decides on. full adds the two NWS narrative members - description (the multi-paragraph WHAT/WHERE/WHEN/IMPACTS text, truncated at 2000 characters with description_truncated set) and instruction (the protective-action text) - which are written for a human reader and are several times the size of the rest of the alert."
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Zero-based index of the first alert to return, for paging through the active set with limit. The whole active set is read in one upstream request and returned in that order, so a window over it is consistent."
}
},
"additionalProperties": false
}| period_limit | integer | Maximum number of 12-hour day/night periods to return, soonest first. Applies when hourly is false; use hours for hourly forecasts. NWS issues 14 periods (7 days); the default of 6 is three days. Named period_limit, not periods, because periods is the returned series. |
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude in decimal degrees (WGS84). Rounded to 4 decimal places before the National Weather Service lookup."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude in decimal degrees (WGS84). Rounded to 4 decimal places before the National Weather Service lookup."
},
"hours": {
"type": "integer",
"default": 24,
"maximum": 48,
"minimum": 1,
"description": "Number of hourly periods to return, soonest first. Applies when hourly is true; use period_limit for day/night forecasts."
},
"detail": {
"enum": [
"compact",
"full"
],
"type": "string",
"default": "compact",
"description": "compact (default) returns the fields an agent acts on. full adds the NWS narrative (detailed_forecast), the icon URL, the trend note and, for hourly periods, dewpoint_c and humidity_pct."
},
"hourly": {
"type": "boolean",
"default": false,
"description": "Return hourly periods instead of the default 12-hour day/night periods. Hourly periods have no name and, at detail=full, carry dewpoint and humidity."
},
"period_limit": {
"type": "integer",
"default": 6,
"maximum": 14,
"minimum": 1,
"description": "Maximum number of 12-hour day/night periods to return, soonest first. Applies when hourly is false; use hours for hourly forecasts. NWS issues 14 periods (7 days); the default of 6 is three days. Named period_limit, not periods, because periods is the returned series."
}
},
"additionalProperties": false
}