capabilities

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.accounts'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.charges'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.directors'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.filings'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.owners'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.profile'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.registered_office'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.search'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.uk.status'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.us.filings'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.us.filings.latest'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.us.profile'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/company.us.resolve'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/domain.expiry'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/domain.registration'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/entity.lei.profile'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/entity.lei.search'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/fx.reference_rate'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/location.us.geocode'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/location.us.geographies'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/parcel.detect_carrier'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/weather.us.alerts'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/weather.us.forecast'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}

{'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}

{'type': 'object', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'object', 'description': 'Capability output; full JSON Schema at https://api.eckari.com/v1/capabilities/weather.us.observation'}, 'meta': {'type': 'object', 'required': ['capability', 'version', 'retrieved_at', 'source', 'freshness', 'request_id'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'freshness': {'type': 'string'}, 'capability': {'type': 'string'}, 'request_id': {'type': 'string'}, 'attribution': {'type': 'string'}, 'retrieved_at': {'type': 'string', 'format': 'date-time'}, 'attribution_url': {'type': 'string', 'format': 'uri'}}}}}