HelpMyAgent
Qué hace este MCP
Provides French company intelligence including profiles, financials, directors, procurement, public funding, KYB, compliance checks and payment context.
Herramientas
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of ranked aid schemes to return'}, 'project': {'type': 'string', 'minLength': 2, 'description': 'Optional project context used to rank matching public aid schemes'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/aids API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'company_status', 'matching_context', 'source_total_count', 'total_candidates', 'returned_count', 'truncated', 'aids'], 'properties': {'aids': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': 'string', 'description': 'Structured value returned for “id” as defined by this API contract.'}, 'name': {'type': 'string', 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'match': {'type': 'object', 'properties': {'score': {'type': 'number', 'description': 'Normalized score produced by the endpoint; interpretation is defined by the tool description and limitations.'}, 'reasons': {'type': 'array', 'description': 'Structured value returned for “reasons” as defined by this API contract.'}, 'matched_profile': {'type': ['string', 'null'], 'description': 'Structured value returned for “matched profile” as defined by this API contract.'}, 'matched_project': {'type': ['string', 'null'], 'description': 'Structured value returned for “matched project” as defined by this API contract.'}, 'unknown_criteria': {'type': 'array', 'description': 'Structured value returned for “unknown criteria” as defined by this API contract.'}, 'matched_territory': {'type': ['string', 'null'], 'description': 'Structured value returned for “matched territory” as defined by this API contract.'}, 'verified_criteria': {'type': 'array', 'description': 'Structured value returned for “verified criteria” as defined by this API contract.'}, 'potentially_eligible': {'type': 'boolean', 'description': 'Structured value returned for “potentially eligible” as defined by this API contract.'}}, 'description': 'Structured value returned for “match” as defined by this API contract.'}, 'amount': {'type': ['string', 'null'], 'description': 'Structured value returned for “amount” as defined by this API contract.'}, 'object': {'type': ['string', 'null'], 'description': 'Structured value returned for “object” as defined by this API contract.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'natures': {'type': 'array', 'description': 'Structured value returned for “natures” as defined by this API contract.'}, 'contacts': {'type': 'array', 'description': 'Structured value returned for “contacts” as defined by this API contract.'}, 'profiles': {'type': 'array', 'description': 'Structured value returned for “profiles” as defined by this API contract.'}, 'projects': {'type': 'array', 'description': 'Structured value returned for “projects” as defined by this API contract.'}, 'conditions': {'type': ['string', 'null'], 'description': 'Structured value returned for “conditions” as defined by this API contract.'}, 'operations': {'type': ['string', 'null'], 'description': 'Structured value returned for “operations” as defined by this API contract.'}, 'source_type': {'enum': ['SOURCE_PUBLIQUE'], 'type': 'string', 'description': 'Structured value returned for “source type” as defined by this API contract. (allowed values: SOURCE_PUBLIQUE).'}, 'territories': {'type': 'array', 'description': 'Structured value returned for “territories” as defined by this API contract.'}, 'valid_until': {'type': ['string', 'null'], 'description': 'Structured value returned for “valid until” as defined by this API contract.'}, 'source_links': {'type': 'array', 'description': 'Structured value returned for “source links” as defined by this API contract.'}, 'beneficiaries': {'type': ['string', 'null'], 'description': 'Structured value returned for “beneficiaries” as defined by this API contract.'}, 'validation_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “validation date” as defined by this API contract.'}, 'application_links': {'type': 'array', 'description': 'Structured value returned for “application links” as defined by this API contract.'}}}, 'description': 'Ranked public funding schemes returned by the endpoint.'}, 'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'company_status': {'type': ['string', 'null'], 'description': 'Current public administrative company status when available.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}, 'matching_context': {'type': 'object', 'description': 'Structured value returned for “matching context” as defined by this API contract.'}, 'total_candidates': {'type': 'integer', 'description': 'Structured value returned for “total candidates” as defined by this API contract.'}, 'source_total_count': {'type': 'integer', 'description': 'Structured value returned for “source total count” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/aids API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'scope': {'enum': ['department', 'region', 'france'], 'type': 'string', 'default': 'region', 'description': 'Geographic comparison scope controlling whether candidates are selected by department, region or all of France. (default region; allowed values: department, region, france).'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}, 'peer_limit': {'type': 'integer', 'default': 5, 'maximum': 10, 'minimum': 2, 'description': 'Maximum number of comparable peer companies used by the benchmark. (minimum 2; maximum 10; default 5).'}}, 'description': 'Structured input parameters for the company/fr/benchmark API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'scope', 'peer_count', 'metrics', 'peers'], 'properties': {'name': {'description': 'Publicly available company, person, buyer or record name for this result.'}, 'peers': {'type': 'array', 'description': 'Structured value returned for “peers” as defined by this API contract.'}, 'scope': {'type': 'string', 'description': 'Structured value returned for “scope” as defined by this API contract.'}, 'siren': {'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'metrics': {'type': 'object', 'description': 'Structured value returned for “metrics” as defined by this API contract.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'peer_count': {'type': 'integer', 'description': 'Structured value returned for “peer count” as defined by this API contract.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}}, 'description': 'Structured result returned by the company/fr/benchmark API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/certifications API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'certifications_count', 'certifications', 'sources'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['source', 'source_type', 'status', 'records', 'scope'], 'properties': {'scope': {'type': ['string', 'null'], 'description': 'Structured value returned for “scope” as defined by this API contract.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'status': {'enum': ['ok', 'unavailable', 'not_queried'], 'type': 'string', 'description': 'Normalized endpoint or source status. (allowed values: ok, unavailable, not_queried).'}, 'records': {'type': 'integer', 'description': 'Structured value returned for “records” as defined by this API contract.'}, 'source_type': {'type': 'string', 'description': 'Structured value returned for “source type” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Public data sources used or checked for this result.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'certifications': {'type': 'array', 'items': {'type': 'object', 'required': ['type', 'source', 'source_type', 'siret', 'status', 'source_status', 'name', 'issuer', 'code', 'valid_from', 'valid_until', 'certificate_url', 'scopes'], 'properties': {'code': {'type': ['string', 'null'], 'description': 'Structured value returned for “code” as defined by this API contract.'}, 'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'type': {'type': 'string', 'description': 'Structured value returned for “type” as defined by this API contract.'}, 'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'issuer': {'type': ['string', 'null'], 'description': 'Structured value returned for “issuer” as defined by this API contract.'}, 'scopes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “scopes” as defined by this API contract.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'status': {'type': 'string', 'description': 'Normalized endpoint or source status.'}, 'valid_from': {'type': ['string', 'null'], 'description': 'Structured value returned for “valid from” as defined by this API contract.'}, 'source_type': {'enum': ['SOURCE_PUBLIQUE'], 'type': 'string', 'description': 'Structured value returned for “source type” as defined by this API contract. (allowed values: SOURCE_PUBLIQUE).'}, 'valid_until': {'type': ['string', 'null'], 'description': 'Structured value returned for “valid until” as defined by this API contract.'}, 'source_status': {'type': ['string', 'null'], 'description': 'Availability status of the relevant upstream public source.'}, 'certificate_url': {'type': ['string', 'null'], 'description': 'Structured value returned for “certificate url” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Normalized public certification records returned by the endpoint.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}, 'certifications_count': {'type': 'integer', 'description': 'Structured value returned for “certifications count” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/certifications API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 100, 'maximum': 100, 'minimum': 1, 'description': 'Maximum changes to return, up to 100'}, 'since': {'type': 'string', 'format': 'date', 'description': 'Optional inclusive change start date'}, 'until': {'type': 'string', 'format': 'date', 'description': 'Optional inclusive change end date'}, 'offset': {'type': 'integer', 'default': 0, 'minimum': 0, 'description': 'Zero-based offset within the filtered change list; use next_offset to continue'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/changes API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'siren', 'exists', 'since', 'until', 'offset', 'next_offset', 'limit', 'total_count', 'returned_count', 'truncated', 'changes'], 'properties': {'limit': {'type': 'integer', 'description': 'Structured value returned for “limit” as defined by this API contract.'}, 'since': {'type': ['string', 'null'], 'description': 'Structured value returned for “since” as defined by this API contract.'}, 'siren': {'type': 'string', 'description': 'Normalized 9-digit French SIREN when available.'}, 'until': {'type': ['string', 'null'], 'description': 'Structured value returned for “until” as defined by this API contract.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'offset': {'type': 'integer', 'description': 'Structured value returned for “offset” as defined by this API contract.'}, 'changes': {'type': 'array', 'items': {'type': 'object', 'required': ['date', 'changed_fields', 'state'], 'properties': {'date': {'type': ['string', 'null'], 'description': 'Structured value returned for “date” as defined by this API contract.'}, 'state': {'type': 'object', 'required': ['start_date', 'end_date', 'status', 'name', 'usual_name', 'legal_form_code', 'activity_code', 'activity_nomenclature', 'headquarters_nic', 'is_employer', 'is_social_solidarity_economy', 'is_mission_company'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'status': {'enum': ['active', 'closed', None], 'type': ['string', 'null'], 'description': 'Normalized endpoint or source status. (allowed values: active, closed).'}, 'end_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “end date” as defined by this API contract.'}, 'start_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “start date” as defined by this API contract.'}, 'usual_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “usual name” as defined by this API contract.'}, 'is_employer': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is employer” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'legal_form_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “legal form code” as defined by this API contract.'}, 'headquarters_nic': {'type': ['string', 'null'], 'description': 'Structured value returned for “headquarters nic” as defined by this API contract.'}, 'is_mission_company': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is mission company” as defined by this API contract.'}, 'activity_nomenclature': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity nomenclature” as defined by this API contract.'}, 'is_social_solidarity_economy': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is social solidarity economy” as defined by this API contract.'}}, 'description': 'Structured value returned for “state” as defined by this API contract.', 'additionalProperties': False}, 'changed_fields': {'type': 'array', 'items': {'type': 'object', 'required': ['field', 'value'], 'properties': {'field': {'type': 'string', 'description': 'Structured value returned for “field” as defined by this API contract.'}, 'value': {'type': ['string', 'boolean', 'null'], 'description': 'Structured value returned for “value” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “changed fields” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “changes” as defined by this API contract.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'next_offset': {'type': ['integer', 'null'], 'description': 'Structured value returned for “next offset” as defined by this API contract.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/changes API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'Maximum results to return, up to 100'}, 'since': {'type': 'string', 'format': 'date', 'description': 'Inclusive start date; defaults to a 7-day window'}, 'until': {'type': 'string', 'format': 'date', 'description': 'Inclusive end date; defaults to today'}, 'cursor': {'type': 'string', 'default': '*', 'maxLength': 4096, 'minLength': 1, 'description': 'Opaque Sirene cursor from next_cursor; omit it on the first call'}}, 'description': 'Structured input parameters for the company/fr/closures API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['since', 'until', 'cursor', 'next_cursor', 'limit', 'total_count', 'returned_count', 'truncated', 'closures'], 'properties': {'limit': {'type': 'integer', 'description': 'Structured value returned for “limit” as defined by this API contract.'}, 'since': {'type': 'string', 'description': 'Structured value returned for “since” as defined by this API contract.'}, 'until': {'type': 'string', 'description': 'Structured value returned for “until” as defined by this API contract.'}, 'cursor': {'type': 'string', 'description': 'Structured value returned for “cursor” as defined by this API contract.'}, 'closures': {'type': 'array', 'items': {'type': 'object', 'required': ['siren', 'name', 'closure_date', 'activity_code', 'legal_form_code', 'current_status', 'last_processed_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'closure_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “closure date” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'current_status': {'enum': ['active', 'closed', None], 'type': ['string', 'null'], 'description': 'Structured value returned for “current status” as defined by this API contract. (allowed values: active, closed).'}, 'legal_form_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “legal form code” as defined by this API contract.'}, 'last_processed_at': {'type': ['string', 'null'], 'description': 'Structured value returned for “last processed at” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “closures” as defined by this API contract.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'next_cursor': {'type': ['string', 'null'], 'description': 'Structured value returned for “next cursor” as defined by this API contract.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the company/fr/closures API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifiers'], 'properties': {'identifiers': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$'}, 'maxItems': 5, 'minItems': 2, 'description': 'List of French company identifiers to process; each item must be a 9-digit SIREN or 14-digit SIRET. (at least 2 items; at most 5 items).'}}, 'description': 'Structured input parameters for the company/fr/compare API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['companies', 'comparability', 'rankings'], 'properties': {'rankings': {'type': 'object', 'description': 'Structured value returned for “rankings” as defined by this API contract.'}, 'companies': {'type': 'array', 'description': 'Structured company records returned by the endpoint.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'comparability': {'type': 'object', 'description': 'Structured value returned for “comparability” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/compare API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'domain': {'type': 'string', 'description': 'Optional domain to check separately; it is not considered officially associated with the company'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/compliance API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'company_status', 'domain', 'status', 'checked_at', 'checks', 'matches'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'checks': {'type': 'array', 'items': {'type': 'object', 'properties': {'check': {'type': 'string', 'description': 'Structured value returned for “check” as defined by this API contract.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'status': {'enum': ['ok', 'unavailable', 'not_queried'], 'type': 'string', 'description': 'Normalized endpoint or source status. (allowed values: ok, unavailable, not_queried).'}, 'limitation': {'type': 'string', 'description': 'Structured value returned for “limitation” as defined by this API contract.'}, 'match_count': {'type': 'integer', 'description': 'Number of candidate matches returned by the screening operation.'}, 'source_type': {'type': 'string', 'description': 'Structured value returned for “source type” as defined by this API contract.'}, 'source_records': {'type': ['integer', 'null'], 'description': 'Structured value returned for “source records” as defined by this API contract.'}, 'publication_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “publication date” as defined by this API contract.'}}}, 'description': 'Structured value returned for “checks” as defined by this API contract.'}, 'domain': {'type': ['string', 'null'], 'description': 'Structured value returned for “domain” as defined by this API contract.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'status': {'enum': ['PUBLIC_ALERT_FOUND', 'NO_PUBLIC_ALERT_FOUND', 'INCOMPLETE', 'COMPANY_NOT_FOUND'], 'type': 'string', 'description': 'Normalized endpoint or source status. (allowed values: PUBLIC_ALERT_FOUND, NO_PUBLIC_ALERT_FOUND, INCOMPLETE, COMPANY_NOT_FOUND).'}, 'matches': {'type': 'array', 'items': {'type': 'object', 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'check': {'type': 'string', 'description': 'Structured value returned for “check” as defined by this API contract.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'subject': {'enum': ['company_identity', 'domain_input'], 'type': 'string', 'description': 'Structured value returned for “subject” as defined by this API contract. (allowed values: company_identity, domain_input).'}, 'confidence': {'type': 'number', 'description': 'Confidence indicator associated with an inferred or derived result.'}, 'source_type': {'type': 'string', 'description': 'Structured value returned for “source type” as defined by this API contract.'}, 'match_method': {'type': 'string', 'description': 'Structured value returned for “match method” as defined by this API contract.'}, 'match_source_type': {'enum': ['SOURCE_PUBLIQUE', 'INFERE'], 'type': 'string', 'description': 'Structured value returned for “match source type” as defined by this API contract. (allowed values: SOURCE_PUBLIQUE, INFERE).'}}}, 'description': 'Candidate public-list or source matches returned by the endpoint.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'regulatory': {'type': 'object', 'required': ['source_status', 'regulated', 'approval_count'], 'properties': {'regulated': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “regulated” as defined by this API contract.'}, 'source_status': {'enum': ['ok', 'unavailable', 'not_queried'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, unavailable, not_queried).'}, 'approval_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “approval count” as defined by this API contract.'}}, 'description': 'Structured value returned for “regulatory” as defined by this API contract.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'company_status': {'type': ['string', 'null'], 'description': 'Current public administrative company status when available.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/compliance API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/default-score API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'score', 'level', 'confidence', 'components'], 'properties': {'name': {'description': 'Publicly available company, person, buyer or record name for this result.'}, 'level': {'type': 'string', 'description': 'Structured value returned for “level” as defined by this API contract.'}, 'score': {'description': 'Normalized score produced by the endpoint; interpretation is defined by the tool description and limitations.'}, 'siren': {'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'components': {'type': 'array', 'description': 'Structured value returned for “components” as defined by this API contract.'}, 'confidence': {'type': 'string', 'description': 'Confidence indicator associated with an inferred or derived result.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'identifier_type': {'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable.'}, 'known_weight_percent': {'description': 'Structured value returned for “known weight percent” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/default-score API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['last_name'], 'properties': {'page': {'type': 'integer', 'default': 1, 'minimum': 1, 'description': 'One-based result page number. (minimum 1; default 1).'}, 'limit': {'type': 'integer', 'default': 25, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 25; default 25).'}, 'last_name': {'type': 'string', 'minLength': 2, 'description': 'Director family name to search in public French company mandates; name matching can include homonyms. (minimum length 2).'}, 'first_names': {'type': 'string', 'description': 'Optional first name or given names used to narrow director-mandate matches.'}}, 'description': 'Structured input parameters for the company/fr/director-mandates API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['last_name', 'first_names', 'page', 'limit', 'total_companies', 'returned_mandates', 'mandates'], 'properties': {'page': {'type': 'integer', 'description': 'Structured value returned for “page” as defined by this API contract.'}, 'limit': {'type': 'integer', 'description': 'Structured value returned for “limit” as defined by this API contract.'}, 'mandates': {'type': 'array', 'description': 'Structured value returned for “mandates” as defined by this API contract.'}, 'last_name': {'type': 'string', 'description': 'Structured value returned for “last name” as defined by this API contract.'}, 'first_names': {'description': 'Structured value returned for “first names” as defined by this API contract.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'total_companies': {'type': 'integer', 'description': 'Structured value returned for “total companies” as defined by this API contract.'}, 'returned_mandates': {'type': 'integer', 'description': 'Structured value returned for “returned mandates” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/director-mandates API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/directors API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'directors'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'directors': {'type': 'array', 'items': {'type': 'object', 'required': ['type', 'role', 'name', 'first_names', 'birth_year', 'siren'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'role': {'type': ['string', 'null'], 'description': 'Structured value returned for “role” as defined by this API contract.'}, 'type': {'enum': ['person', 'company', None], 'type': ['string', 'null'], 'description': 'Structured value returned for “type” as defined by this API contract. (allowed values: person, company).'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'birth_year': {'type': ['string', 'null'], 'description': 'Structured value returned for “birth year” as defined by this API contract.'}, 'first_names': {'type': ['string', 'null'], 'description': 'Structured value returned for “first names” as defined by this API contract.'}}}, 'description': 'Publicly listed directors or legal representatives returned by the endpoint.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/directors API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/e-invoice API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'company_category', 'vat_number', 'headquarters_siret', 'headquarters_address', 'receiving_obligation_from', 'issuing_obligation_from', 'establishment_scope', 'prepared_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'vat_number': {'type': ['string', 'null'], 'description': 'Structured value returned for “vat number” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'prepared_at': {'type': 'string', 'description': 'Structured value returned for “prepared at” as defined by this API contract.'}, 'company_category': {'type': ['string', 'null'], 'description': 'Structured value returned for “company category” as defined by this API contract.'}, 'headquarters_siret': {'type': ['string', 'null'], 'description': 'Structured value returned for “headquarters siret” as defined by this API contract.'}, 'establishment_scope': {'type': 'string', 'description': 'Structured value returned for “establishment scope” as defined by this API contract.'}, 'headquarters_address': {'type': ['string', 'null'], 'description': 'Structured value returned for “headquarters address” as defined by this API contract.'}, 'issuing_obligation_from': {'type': ['string', 'null'], 'description': 'Structured value returned for “issuing obligation from” as defined by this API contract.'}, 'receiving_obligation_from': {'type': ['string', 'null'], 'description': 'Structured value returned for “receiving obligation from” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/e-invoice API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'Maximum establishments to return, up to 100'}, 'cursor': {'type': 'string', 'default': '*', 'maxLength': 4096, 'minLength': 1, 'description': 'Opaque Sirene cursor from next_cursor; omit it on the first call'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/establishments API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'siren', 'exists', 'cursor', 'next_cursor', 'limit', 'total_count', 'returned_count', 'truncated', 'establishments'], 'properties': {'limit': {'type': 'integer', 'description': 'Structured value returned for “limit” as defined by this API contract.'}, 'siren': {'type': 'string', 'description': 'Normalized 9-digit French SIREN when available.'}, 'cursor': {'type': 'string', 'description': 'Structured value returned for “cursor” as defined by this API contract.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'next_cursor': {'type': ['string', 'null'], 'description': 'Structured value returned for “next cursor” as defined by this API contract.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'establishments': {'type': 'array', 'items': {'type': 'object', 'required': ['siret', 'status', 'is_headquarters', 'activity_code', 'activity_nomenclature', 'creation_date', 'closure_date', 'employee_band_code', 'employee_band_year', 'is_employer', 'address', 'postal_code', 'city', 'commune_code', 'last_processed_at'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'status': {'enum': ['active', 'closed', None], 'type': ['string', 'null'], 'description': 'Normalized endpoint or source status. (allowed values: active, closed).'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'is_employer': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is employer” as defined by this API contract.'}, 'postal_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “postal code” as defined by this API contract.'}, 'closure_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “closure date” as defined by this API contract.'}, 'commune_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “commune code” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'creation_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “creation date” as defined by this API contract.'}, 'is_headquarters': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is headquarters” as defined by this API contract.'}, 'last_processed_at': {'type': ['string', 'null'], 'description': 'Structured value returned for “last processed at” as defined by this API contract.'}, 'employee_band_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “employee band code” as defined by this API contract.'}, 'employee_band_year': {'type': ['string', 'null'], 'description': 'Structured value returned for “employee band year” as defined by this API contract.'}, 'activity_nomenclature': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity nomenclature” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “establishments” as defined by this API contract.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/establishments API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 20, 'maximum': 50, 'minimum': 1, 'description': 'Maximum number of normalized BODACC events to return'}, 'since': {'type': 'string', 'format': 'date', 'description': 'Minimum included BODACC publication date in YYYY-MM-DD format'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/events API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'total_count', 'returned_count', 'truncated', 'latest_event', 'events'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'events': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': ['string', 'null'], 'description': 'Structured value returned for “id” as defined by this API contract.'}, 'url': {'type': ['string', 'null'], 'description': 'Structured value returned for “url” as defined by this API contract.'}, 'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'type': {'enum': ['collective_procedure', 'radiation', 'accounts_filing', 'act', 'modification', 'other'], 'type': 'string', 'description': 'Structured value returned for “type” as defined by this API contract. (allowed values: collective_procedure, radiation, accounts_filing, act, modification, other).'}, 'title': {'type': ['string', 'null'], 'description': 'Structured value returned for “title” as defined by this API contract.'}, 'family': {'type': ['string', 'null'], 'description': 'Structured value returned for “family” as defined by this API contract.'}, 'tribunal': {'type': ['string', 'null'], 'description': 'Structured value returned for “tribunal” as defined by this API contract.'}, 'department': {'type': ['string', 'null'], 'description': 'Structured value returned for “department” as defined by this API contract.'}, 'event_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “event date” as defined by this API contract.'}, 'family_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “family code” as defined by this API contract.'}, 'notice_type': {'type': ['string', 'null'], 'description': 'Structured value returned for “notice type” as defined by this API contract.'}, 'publication_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “publication date” as defined by this API contract.'}}}, 'description': 'Normalized public events returned by the endpoint.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'latest_event': {'type': ['object', 'null'], 'description': 'Structured value returned for “latest event” as defined by this API contract.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/events API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/financials API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'summary', 'financials'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'summary': {'type': 'object', 'required': ['years_available', 'latest_year', 'latest_revenue', 'latest_net_income', 'latest_revenue_growth_percent', 'latest_net_margin_percent'], 'properties': {'latest_year': {'type': ['string', 'null'], 'description': 'Structured value returned for “latest year” as defined by this API contract.'}, 'latest_revenue': {'type': ['number', 'null'], 'description': 'Structured value returned for “latest revenue” as defined by this API contract.'}, 'years_available': {'type': 'integer', 'description': 'Structured value returned for “years available” as defined by this API contract.'}, 'latest_net_income': {'type': ['number', 'null'], 'description': 'Structured value returned for “latest net income” as defined by this API contract.'}, 'latest_net_margin_percent': {'type': ['number', 'null'], 'description': 'Structured value returned for “latest net margin percent” as defined by this API contract.'}, 'latest_revenue_growth_percent': {'type': ['number', 'null'], 'description': 'Structured value returned for “latest revenue growth percent” as defined by this API contract.'}}, 'description': 'Compact derived summary of the returned records.', 'additionalProperties': False}, 'financials': {'type': 'array', 'items': {'type': 'object', 'required': ['year', 'revenue', 'net_income', 'revenue_growth_percent', 'net_margin_percent'], 'properties': {'year': {'type': 'string', 'description': 'Structured value returned for “year” as defined by this API contract.'}, 'revenue': {'type': ['number', 'null'], 'description': 'Structured value returned for “revenue” as defined by this API contract.'}, 'net_income': {'type': ['number', 'null'], 'description': 'Structured value returned for “net income” as defined by this API contract.'}, 'net_margin_percent': {'type': ['number', 'null'], 'description': 'Structured value returned for “net margin percent” as defined by this API contract.'}, 'revenue_growth_percent': {'type': ['number', 'null'], 'description': 'Structured value returned for “revenue growth percent” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Normalized public financial-year records returned by the endpoint.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/financials API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET; a SIRET is normalized to its SIREN'}}, 'description': 'Structured input parameters for the company/fr/history API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'siren', 'exists', 'current', 'periods_count', 'periods'], 'properties': {'siren': {'type': 'string', 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'current': {'type': ['object', 'null'], 'required': ['siren', 'name', 'status', 'creation_date', 'closure_date', 'activity_code', 'legal_form_code', 'employee_band_code', 'employee_band_year', 'company_category', 'last_processed_at', 'periods_count'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'status': {'enum': ['active', 'closed', None], 'type': ['string', 'null'], 'description': 'Normalized endpoint or source status. (allowed values: active, closed).'}, 'closure_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “closure date” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'creation_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “creation date” as defined by this API contract.'}, 'periods_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “periods count” as defined by this API contract.'}, 'legal_form_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “legal form code” as defined by this API contract.'}, 'company_category': {'type': ['string', 'null'], 'description': 'Structured value returned for “company category” as defined by this API contract.'}, 'last_processed_at': {'type': ['string', 'null'], 'description': 'Structured value returned for “last processed at” as defined by this API contract.'}, 'employee_band_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “employee band code” as defined by this API contract.'}, 'employee_band_year': {'type': ['string', 'null'], 'description': 'Structured value returned for “employee band year” as defined by this API contract.'}}, 'description': 'Structured value returned for “current” as defined by this API contract.', 'additionalProperties': False}, 'periods': {'type': 'array', 'items': {'type': 'object', 'required': ['start_date', 'end_date', 'status', 'name', 'usual_name', 'legal_form_code', 'activity_code', 'activity_nomenclature', 'headquarters_nic', 'is_employer', 'is_social_solidarity_economy', 'is_mission_company', 'changed_fields'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'status': {'enum': ['active', 'closed', None], 'type': ['string', 'null'], 'description': 'Normalized endpoint or source status. (allowed values: active, closed).'}, 'end_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “end date” as defined by this API contract.'}, 'start_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “start date” as defined by this API contract.'}, 'usual_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “usual name” as defined by this API contract.'}, 'is_employer': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is employer” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'changed_fields': {'type': 'array', 'items': {'type': 'object', 'required': ['field', 'value'], 'properties': {'field': {'type': 'string', 'description': 'Structured value returned for “field” as defined by this API contract.'}, 'value': {'type': ['string', 'boolean', 'null'], 'description': 'Structured value returned for “value” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “changed fields” as defined by this API contract.'}, 'legal_form_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “legal form code” as defined by this API contract.'}, 'headquarters_nic': {'type': ['string', 'null'], 'description': 'Structured value returned for “headquarters nic” as defined by this API contract.'}, 'is_mission_company': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is mission company” as defined by this API contract.'}, 'activity_nomenclature': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity nomenclature” as defined by this API contract.'}, 'is_social_solidarity_economy': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is social solidarity economy” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “periods” as defined by this API contract.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'periods_count': {'type': 'integer', 'description': 'Structured value returned for “periods count” as defined by this API contract.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/history API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/industrial-risk API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'headquarters_commune_code', 'source_status', 'establishments_total', 'establishments_scanned', 'communes_total', 'communes_scanned', 'installation_count', 'installations', 'coverage_complete', 'checked_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'installations': {'type': 'array', 'items': {'type': 'object', 'required': ['code_aiot', 'name', 'siret', 'address', 'city', 'status', 'regime', 'seveso', 'ied'], 'properties': {'ied': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “ied” as defined by this API contract.'}, 'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siret': {'type': 'string', 'description': 'Normalized 14-digit French SIRET when available.'}, 'regime': {'type': ['string', 'null'], 'description': 'Structured value returned for “regime” as defined by this API contract.'}, 'seveso': {'type': ['string', 'null'], 'description': 'Structured value returned for “seveso” as defined by this API contract.'}, 'status': {'type': ['string', 'null'], 'description': 'Normalized endpoint or source status.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'code_aiot': {'type': ['string', 'null'], 'description': 'Structured value returned for “code aiot” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “installations” as defined by this API contract.'}, 'source_status': {'enum': ['ok', 'partial', 'unavailable', 'not_queried'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, partial, unavailable, not_queried).'}, 'communes_total': {'type': 'integer', 'description': 'Structured value returned for “communes total” as defined by this API contract.'}, 'communes_scanned': {'type': 'integer', 'description': 'Structured value returned for “communes scanned” as defined by this API contract.'}, 'coverage_complete': {'type': 'boolean', 'description': 'Whether the checked public-source coverage was sufficient for the endpoint’s stated scope.'}, 'installation_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “installation count” as defined by this API contract.'}, 'establishments_total': {'type': ['integer', 'null'], 'description': 'Structured value returned for “establishments total” as defined by this API contract.'}, 'establishments_scanned': {'type': 'integer', 'description': 'Structured value returned for “establishments scanned” as defined by this API contract.'}, 'headquarters_commune_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “headquarters commune code” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/industrial-risk API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'domain': {'type': 'string', 'description': 'Optional domain used by the compliance section; it is not treated as an officially verified company domain.'}, 'include': {'type': 'array', 'items': {'enum': ['profile', 'directors', 'financials', 'events', 'risk', 'certifications', 'public_contracts', 'compliance', 'aids', 'signals', 'opportunities'], 'type': 'string'}, 'default': ['profile', 'financials', 'risk', 'signals', 'opportunities'], 'minItems': 1, 'description': 'Optional list of existing Company sections to aggregate in the response', 'uniqueItems': True}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/intelligence API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'checked_at', 'sections_requested', 'sections_available', 'sections_unavailable', 'sections'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'sections': {'type': 'object', 'description': 'Named result sections produced by this aggregator.', 'additionalProperties': {'type': 'object', 'required': ['status', 'data'], 'properties': {'data': {'type': ['object', 'null'], 'description': 'Structured value returned for “data” as defined by this API contract.'}, 'status': {'enum': ['ok', 'unavailable', 'not_available'], 'type': 'string', 'description': 'Normalized endpoint or source status. (allowed values: ok, unavailable, not_available).'}}, 'additionalProperties': False}}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}, 'sections_available': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “sections available” as defined by this API contract.'}, 'sections_requested': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “sections requested” as defined by this API contract.'}, 'sections_unavailable': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “sections unavailable” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/intelligence API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'invoice': {'type': 'object', 'properties': {'date': {'type': 'string', 'format': 'date', 'description': 'Optional value for “date” as defined by this API contract.'}, 'total': {'type': 'number', 'minimum': 0, 'description': 'Optional value for “total” as defined by this API contract. (minimum 0).'}, 'number': {'type': 'string', 'minLength': 1, 'description': 'Identifier body used together with the supplied country code. (minimum length 1).'}, 'currency': {'type': 'string', 'pattern': '^[A-Z]{3}$', 'description': 'Optional value for “currency” as defined by this API contract.'}, 'subtotal': {'type': 'number', 'minimum': 0, 'description': 'Optional value for “subtotal” as defined by this API contract. (minimum 0).'}, 'vat_amount': {'type': 'number', 'minimum': 0, 'description': 'Optional value for “vat amount” as defined by this API contract. (minimum 0).'}, 'supplier_name': {'type': 'string', 'description': 'Optional value for “supplier name” as defined by this API contract.'}}, 'description': 'Optional value for “invoice” as defined by this API contract.', 'additionalProperties': False}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}, 'vat_number': {'type': 'string', 'description': 'Optional or required VAT identifier used by this validation or consistency check.'}}, 'description': 'Structured input parameters for the company/fr/invoice-check API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'expected_vat_number', 'supplied_vat_number', 'format_match', 'vies_status', 'vies_valid', 'vies_name', 'verdict', 'invoice_validation', 'checked_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'verdict': {'type': 'string', 'description': 'Normalized endpoint conclusion derived from the checked public data.'}, 'vies_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “vies name” as defined by this API contract.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'vies_valid': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “vies valid” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'vies_status': {'type': 'string', 'description': 'Structured value returned for “vies status” as defined by this API contract.'}, 'format_match': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “format match” as defined by this API contract.'}, 'invoice_validation': {'type': 'object', 'required': ['provided', 'verdict', 'arithmetic_consistent', 'supplier_name_match', 'invoice_date_valid', 'issues'], 'properties': {'issues': {'type': 'array', 'items': {'type': 'object', 'required': ['code', 'severity'], 'properties': {'code': {'type': 'string', 'description': 'Structured value returned for “code” as defined by this API contract.'}, 'severity': {'enum': ['warning', 'error'], 'type': 'string', 'description': 'Structured value returned for “severity” as defined by this API contract. (allowed values: warning, error).'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “issues” as defined by this API contract.'}, 'verdict': {'enum': ['not_checked', 'coherent', 'incomplete', 'incoherent'], 'type': 'string', 'description': 'Normalized endpoint conclusion derived from the checked public data. (allowed values: not_checked, coherent, incomplete, incoherent).'}, 'provided': {'type': 'boolean', 'description': 'Structured value returned for “provided” as defined by this API contract.'}, 'invoice_date_valid': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “invoice date valid” as defined by this API contract.'}, 'supplier_name_match': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “supplier name match” as defined by this API contract.'}, 'arithmetic_consistent': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “arithmetic consistent” as defined by this API contract.'}}, 'description': 'Structured value returned for “invoice validation” as defined by this API contract.', 'additionalProperties': False}, 'expected_vat_number': {'type': ['string', 'null'], 'description': 'Structured value returned for “expected vat number” as defined by this API contract.'}, 'supplied_vat_number': {'type': ['string', 'null'], 'description': 'Structured value returned for “supplied vat number” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/invoice-check API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifiers'], 'properties': {'identifiers': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$'}, 'maxItems': 10, 'minItems': 2, 'description': 'List of French company identifiers to process; each item must be a 9-digit SIREN or 14-digit SIRET. (at least 2 items; at most 10 items).', 'uniqueItems': True}}, 'description': 'Structured input parameters for the company/fr/kyb-batch API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['requested_count', 'completed_count', 'failed_count', 'results', 'checked_at'], 'properties': {'results': {'type': 'array', 'items': {'type': 'object', 'required': ['identifier', 'status', 'data', 'error'], 'properties': {'data': {'type': ['object', 'null'], 'description': 'Structured value returned for “data” as defined by this API contract.', 'additionalProperties': True}, 'error': {'type': ['string', 'null'], 'description': 'Structured value returned for “error” as defined by this API contract.'}, 'status': {'type': 'string', 'description': 'Normalized endpoint or source status.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}}, 'additionalProperties': False}, 'description': 'Structured result records returned by the endpoint.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'failed_count': {'type': 'integer', 'description': 'Structured value returned for “failed count” as defined by this API contract.'}, 'completed_count': {'type': 'integer', 'description': 'Structured value returned for “completed count” as defined by this API contract.'}, 'requested_count': {'type': 'integer', 'description': 'Structured value returned for “requested count” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/kyb-batch API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 100; default 25).'}, 'since': {'type': 'string', 'format': 'date', 'description': 'Earliest publication or event date to include, in YYYY-MM-DD format.'}, 'until': {'type': 'string', 'format': 'date', 'description': 'Latest publication or event date to include, in YYYY-MM-DD format.'}, 'department': {'type': 'string', 'description': 'Optional French department code used to restrict results geographically.'}, 'family_code': {'type': 'string', 'description': 'Optional BODACC announcement family code used to restrict legal-announcement results.'}}, 'description': 'Structured input parameters for the company/fr/legal-announcements-search API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['criteria', 'total_count', 'returned_count', 'truncated', 'announcements'], 'properties': {'criteria': {'type': 'object', 'description': 'Structured value returned for “criteria” as defined by this API contract.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'announcements': {'type': 'array', 'description': 'Structured value returned for “announcements” as defined by this API contract.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the company/fr/legal-announcements-search API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/lobbying API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'source_status', 'registered', 'declared_name', 'registration_date', 'activity_topics', 'domains', 'clients', 'source_json_url', 'checked_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'clients': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “clients” as defined by this API contract.'}, 'domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “domains” as defined by this API contract.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'registered': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “registered” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'declared_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “declared name” as defined by this API contract.'}, 'source_status': {'enum': ['ok', 'unavailable', 'not_queried'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, unavailable, not_queried).'}, 'activity_topics': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “activity topics” as defined by this API contract.'}, 'source_json_url': {'type': ['string', 'null'], 'description': 'Structured value returned for “source json url” as defined by this API contract.'}, 'registration_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “registration date” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/lobbying API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['latitude', 'longitude'], 'properties': {'limit': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 25; default 10).'}, 'latitude': {'type': 'number', 'maximum': 90, 'minimum': -90, 'description': 'Latitude in decimal degrees for the centre of the geographic search. (minimum -90; maximum 90).'}, 'longitude': {'type': 'number', 'maximum': 180, 'minimum': -180, 'description': 'Longitude in decimal degrees for the centre of the geographic search. (minimum -180; maximum 180).'}, 'radius_km': {'type': 'number', 'default': 5, 'maximum': 50, 'description': 'Search radius around the supplied coordinates, expressed in kilometres. (greater than 0; maximum 50; default 5).', 'exclusiveMinimum': 0}, 'activity_code': {'type': 'string', 'description': 'Optional French NAF activity code used to restrict nearby-company results.'}, 'activity_section': {'type': 'string', 'pattern': '^[A-U]$', 'description': 'Optional NAF activity section letter used to restrict nearby-company results.'}}, 'description': 'Structured input parameters for the company/fr/nearby API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['latitude', 'longitude', 'radius_km', 'activity_code', 'activity_section', 'total_count', 'returned_count', 'truncated', 'companies'], 'properties': {'latitude': {'type': 'number', 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'companies': {'type': 'array', 'description': 'Structured company records returned by the endpoint.'}, 'longitude': {'type': 'number', 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'radius_km': {'type': 'number', 'description': 'Structured value returned for “radius km” as defined by this API contract.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'activity_code': {'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}, 'activity_section': {'description': 'Structured value returned for “activity section” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/nearby API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'Maximum results to return, up to 100'}, 'since': {'type': 'string', 'format': 'date', 'description': 'Inclusive start date; defaults to a 7-day window'}, 'until': {'type': 'string', 'format': 'date', 'description': 'Inclusive end date; defaults to today'}, 'cursor': {'type': 'string', 'default': '*', 'maxLength': 4096, 'minLength': 1, 'description': 'Opaque Sirene cursor from next_cursor; omit it on the first call'}}, 'description': 'Structured input parameters for the company/fr/new API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['since', 'until', 'cursor', 'next_cursor', 'limit', 'total_count', 'returned_count', 'truncated', 'companies'], 'properties': {'limit': {'type': 'integer', 'description': 'Structured value returned for “limit” as defined by this API contract.'}, 'since': {'type': 'string', 'description': 'Structured value returned for “since” as defined by this API contract.'}, 'until': {'type': 'string', 'description': 'Structured value returned for “until” as defined by this API contract.'}, 'cursor': {'type': 'string', 'description': 'Structured value returned for “cursor” as defined by this API contract.'}, 'companies': {'type': 'array', 'items': {'type': 'object', 'required': ['siren', 'name', 'status', 'creation_date', 'closure_date', 'activity_code', 'legal_form_code', 'employee_band_code', 'employee_band_year', 'company_category', 'last_processed_at', 'periods_count'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'status': {'enum': ['active', 'closed', None], 'type': ['string', 'null'], 'description': 'Normalized endpoint or source status. (allowed values: active, closed).'}, 'closure_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “closure date” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'creation_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “creation date” as defined by this API contract.'}, 'periods_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “periods count” as defined by this API contract.'}, 'legal_form_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “legal form code” as defined by this API contract.'}, 'company_category': {'type': ['string', 'null'], 'description': 'Structured value returned for “company category” as defined by this API contract.'}, 'last_processed_at': {'type': ['string', 'null'], 'description': 'Structured value returned for “last processed at” as defined by this API contract.'}, 'employee_band_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “employee band code” as defined by this API contract.'}, 'employee_band_year': {'type': ['string', 'null'], 'description': 'Structured value returned for “employee band year” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured company records returned by the endpoint.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'next_cursor': {'type': ['string', 'null'], 'description': 'Structured value returned for “next cursor” as defined by this API contract.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the company/fr/new API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of ranked opportunities to return'}, 'project': {'type': 'string', 'minLength': 2, 'description': 'Optional project context used for public-aid and opportunity matching'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/opportunities API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'company_status', 'project', 'total_candidates', 'returned_count', 'truncated', 'opportunities', 'coverage'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'project': {'type': ['string', 'null'], 'description': 'Structured value returned for “project” as defined by this API contract.'}, 'coverage': {'type': 'array', 'items': {'type': 'object', 'required': ['service', 'status'], 'properties': {'status': {'type': 'string', 'description': 'Normalized endpoint or source status.'}, 'service': {'type': 'string', 'description': 'Structured value returned for “service” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Coverage information describing which underlying services or sources were available.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'opportunities': {'type': 'array', 'items': {'type': 'object', 'required': ['type', 'score', 'title', 'reasons', 'source_data', 'sources'], 'properties': {'type': {'enum': ['PUBLIC_AID', 'PUBLIC_TENDER'], 'type': 'string', 'description': 'Structured value returned for “type” as defined by this API contract. (allowed values: PUBLIC_AID, PUBLIC_TENDER).'}, 'score': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Normalized score produced by the endpoint; interpretation is defined by the tool description and limitations. (minimum 0; maximum 1).'}, 'title': {'type': 'string', 'description': 'Structured value returned for “title” as defined by this API contract.'}, 'reasons': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “reasons” as defined by this API contract.'}, 'sources': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Public data sources used or checked for this result.'}, 'source_data': {'type': 'object', 'description': 'Structured value returned for “source data” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Ranked public-data opportunities returned by the endpoint.'}, 'company_status': {'type': ['string', 'null'], 'description': 'Current public administrative company status when available.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}, 'total_candidates': {'type': 'integer', 'description': 'Structured value returned for “total candidates” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/opportunities API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'domain': {'type': 'string', 'description': 'Optional domain supplied as additional counterparty context; it is checked separately and is not treated as proof of company ownership.'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/payment-context API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'company_status', 'legal_risk', 'compliance_status', 'public_alerts_found', 'collective_procedure_events', 'radiation_events', 'latest_relevant_event', 'checked_at', 'coverage'], 'properties': {'name': {'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'coverage': {'type': 'array', 'description': 'Coverage information describing which underlying services or sources were available.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'legal_risk': {'description': 'Structured value returned for “legal risk” as defined by this API contract.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'company_status': {'description': 'Current public administrative company status when available.'}, 'identifier_type': {'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable.'}, 'radiation_events': {'type': ['integer', 'null'], 'description': 'Structured value returned for “radiation events” as defined by this API contract.'}, 'compliance_status': {'type': 'string', 'description': 'Structured value returned for “compliance status” as defined by this API contract.'}, 'public_alerts_found': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “public alerts found” as defined by this API contract.'}, 'latest_relevant_event': {'description': 'Structured value returned for “latest relevant event” as defined by this API contract.'}, 'collective_procedure_events': {'type': ['integer', 'null'], 'description': 'Structured value returned for “collective procedure events” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/payment-context API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 25; default 10).'}, 'scope': {'enum': ['department', 'region', 'france'], 'type': 'string', 'default': 'region', 'description': 'Geographic comparison scope controlling whether candidates are selected by department, region or all of France. (default region; allowed values: department, region, france).'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/peers API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'scope', 'criteria', 'peers'], 'properties': {'name': {'description': 'Publicly available company, person, buyer or record name for this result.'}, 'peers': {'type': 'array', 'description': 'Structured value returned for “peers” as defined by this API contract.'}, 'scope': {'type': 'string', 'description': 'Structured value returned for “scope” as defined by this API contract.'}, 'siren': {'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'criteria': {'type': 'object', 'description': 'Structured value returned for “criteria” as defined by this API contract.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}}, 'description': 'Structured result returned by the company/fr/peers API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/profile API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'status', 'legal_form_code', 'creation_date', 'closure_date', 'activity_code', 'company_category', 'employee_band_code', 'employee_band_year', 'is_employer', 'establishments_count', 'open_establishments_count', 'headquarters'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'status': {'type': ['string', 'null'], 'description': 'Normalized endpoint or source status.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'is_employer': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “is employer” as defined by this API contract.'}, 'closure_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “closure date” as defined by this API contract.'}, 'headquarters': {'type': ['object', 'null'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'region': {'type': ['string', 'null'], 'description': 'Structured value returned for “region” as defined by this API contract.'}, 'status': {'type': ['string', 'null'], 'description': 'Normalized endpoint or source status.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'latitude': {'type': ['string', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'longitude': {'type': ['string', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'department': {'type': ['string', 'null'], 'description': 'Structured value returned for “department” as defined by this API contract.'}, 'postal_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “postal code” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'creation_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “creation date” as defined by this API contract.'}}, 'description': 'Structured value returned for “headquarters” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'creation_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “creation date” as defined by this API contract.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}, 'legal_form_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “legal form code” as defined by this API contract.'}, 'company_category': {'type': ['string', 'null'], 'description': 'Structured value returned for “company category” as defined by this API contract.'}, 'employee_band_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “employee band code” as defined by this API contract.'}, 'employee_band_year': {'type': ['string', 'null'], 'description': 'Structured value returned for “employee band year” as defined by this API contract.'}, 'establishments_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “establishments count” as defined by this API contract.'}, 'open_establishments_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “open establishments count” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/profile API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'bio': {'type': 'boolean', 'description': 'When true, restrict results to companies found in the supported public organic/Bio certification source.'}, 'rge': {'type': 'boolean', 'description': 'When true, restrict results to companies with a supported public RGE qualification.'}, 'page': {'type': 'integer', 'default': 1, 'minimum': 1, 'description': 'One-based result page number. (minimum 1; default 1).'}, 'limit': {'type': 'integer', 'default': 25, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 25; default 25).'}, 'query': {'type': 'string', 'description': 'Optional company-name or free-text term combined with the structured prospecting filters.'}, 'region': {'type': 'string', 'description': 'Optional French region code used to restrict results geographically.'}, 'qualiopi': {'type': 'boolean', 'description': 'When true, restrict results to companies found in the supported public Qualiopi source.'}, 'department': {'type': 'string', 'description': 'Optional French department code used to restrict results geographically.'}, 'postal_code': {'type': 'string', 'description': 'Optional French postal code used to narrow results geographically.'}, 'activity_code': {'type': 'string', 'description': 'Optional French NAF activity code used to restrict or classify company results.'}, 'legal_form_code': {'type': 'string', 'description': 'Optional French legal-form code used to restrict company results.'}, 'activity_section': {'type': 'string', 'description': 'Optional NAF activity section used to restrict company results.'}, 'company_category': {'type': 'string', 'description': 'Optional French company-size category used to restrict prospecting results.'}, 'employee_band_code': {'type': 'string', 'description': 'Optional official employee-band code used to restrict company results.'}}, 'description': 'Structured input parameters for the company/fr/prospecting API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['filters', 'page', 'limit', 'total_count', 'returned_count', 'truncated', 'companies'], 'properties': {'page': {'type': 'integer', 'description': 'Structured value returned for “page” as defined by this API contract.'}, 'limit': {'type': 'integer', 'description': 'Structured value returned for “limit” as defined by this API contract.'}, 'filters': {'type': 'object', 'description': 'Structured value returned for “filters” as defined by this API contract.'}, 'companies': {'type': 'array', 'description': 'Structured company records returned by the endpoint.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the company/fr/prospecting API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 25; default 10).'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/public-contract-competitors API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'cpv_segments', 'competitors'], 'properties': {'name': {'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'competitors': {'type': 'array', 'description': 'Structured value returned for “competitors” as defined by this API contract.'}, 'limitations': {'type': 'array', 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'cpv_segments': {'type': 'array', 'description': 'Structured value returned for “cpv segments” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/public-contract-competitors API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 20, 'maximum': 50, 'minimum': 1, 'description': 'Maximum number of awarded public contracts to return'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/public-contracts API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'total_count', 'returned_count', 'truncated', 'summary', 'contracts'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'summary': {'type': 'object', 'properties': {'returned_amount': {'type': ['number', 'null'], 'description': 'Structured value returned for “returned amount” as defined by this API contract.'}, 'top_buyers_in_response': {'type': 'array', 'items': {'type': 'object', 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'contracts_count': {'type': 'integer', 'description': 'Structured value returned for “contracts count” as defined by this API contract.'}}}, 'description': 'Structured value returned for “top buyers in response” as defined by this API contract.'}, 'latest_notification_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “latest notification date” as defined by this API contract.'}}, 'description': 'Compact derived summary of the returned records.'}, 'contracts': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': ['string', 'null'], 'description': 'Structured value returned for “id” as defined by this API contract.'}, 'cpv': {'type': ['string', 'null'], 'description': 'Structured value returned for “cpv” as defined by this API contract.'}, 'buyer': {'type': 'object', 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}}, 'description': 'Structured value returned for “buyer” as defined by this API contract.'}, 'amount': {'type': ['number', 'null'], 'description': 'Structured value returned for “amount” as defined by this API contract.'}, 'nature': {'type': ['string', 'null'], 'description': 'Structured value returned for “nature” as defined by this API contract.'}, 'object': {'type': ['string', 'null'], 'description': 'Structured value returned for “object” as defined by this API contract.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'modified': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “modified” as defined by this API contract.'}, 'procedure': {'type': ['string', 'null'], 'description': 'Structured value returned for “procedure” as defined by this API contract.'}, 'innovative': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “innovative” as defined by this API contract.'}, 'price_form': {'type': ['string', 'null'], 'description': 'Structured value returned for “price form” as defined by this API contract.'}, 'source_type': {'enum': ['SOURCE_PUBLIQUE'], 'type': 'string', 'description': 'Structured value returned for “source type” as defined by this API contract. (allowed values: SOURCE_PUBLIQUE).'}, 'holder_sirets': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “holder sirets” as defined by this API contract.'}, 'duration_months': {'type': ['integer', 'null'], 'description': 'Structured value returned for “duration months” as defined by this API contract.'}, 'publication_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “publication date” as defined by this API contract.'}, 'notification_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “notification date” as defined by this API contract.'}, 'execution_location': {'type': 'object', 'properties': {'code': {'type': ['string', 'null'], 'description': 'Structured value returned for “code” as defined by this API contract.'}, 'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'code_type': {'type': ['string', 'null'], 'description': 'Structured value returned for “code type” as defined by this API contract.'}}, 'description': 'Structured value returned for “execution location” as defined by this API contract.'}, 'modification_amount': {'type': ['number', 'null'], 'description': 'Structured value returned for “modification amount” as defined by this API contract.'}, 'modification_object': {'type': ['string', 'null'], 'description': 'Structured value returned for “modification object” as defined by this API contract.'}, 'social_considerations': {'type': ['string', 'null'], 'description': 'Structured value returned for “social considerations” as defined by this API contract.'}, 'environmental_considerations': {'type': ['string', 'null'], 'description': 'Structured value returned for “environmental considerations” as defined by this API contract.'}}}, 'description': 'Normalized public-contract records returned by the endpoint.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/public-contracts API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'limit': {'type': 'integer', 'default': 20, 'maximum': 50, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 50; default 20).'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/public-contracts-eu API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'source_status', 'search_query', 'returned_count', 'notices', 'checked_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'notices': {'type': 'array', 'items': {'type': 'object', 'required': ['publication_number', 'publication_date', 'title', 'notice_type', 'buyers', 'winners', 'winner_identifiers', 'winner_countries', 'decision_date', 'cpv_codes'], 'properties': {'title': {'type': ['string', 'null'], 'description': 'Structured value returned for “title” as defined by this API contract.'}, 'buyers': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “buyers” as defined by this API contract.'}, 'winners': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “winners” as defined by this API contract.'}, 'cpv_codes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “cpv codes” as defined by this API contract.'}, 'notice_type': {'type': ['string', 'null'], 'description': 'Structured value returned for “notice type” as defined by this API contract.'}, 'decision_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “decision date” as defined by this API contract.'}, 'publication_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “publication date” as defined by this API contract.'}, 'winner_countries': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “winner countries” as defined by this API contract.'}, 'publication_number': {'type': ['string', 'null'], 'description': 'Structured value returned for “publication number” as defined by this API contract.'}, 'winner_identifiers': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “winner identifiers” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “notices” as defined by this API contract.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'search_query': {'type': ['string', 'null'], 'description': 'Structured value returned for “search query” as defined by this API contract.'}, 'source_status': {'enum': ['ok', 'unavailable', 'not_queried'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, unavailable, not_queried).'}, 'returned_count': {'type': ['integer', 'null'], 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the company/fr/public-contracts-eu API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/regulatory-approvals API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'source_status', 'regulated', 'approval_count', 'approvals', 'checked_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'approvals': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'siren', 'lei', 'cib', 'status', 'category', 'activities'], 'properties': {'cib': {'type': ['string', 'null'], 'description': 'Structured value returned for “cib” as defined by this API contract.'}, 'lei': {'type': ['string', 'null'], 'description': 'Structured value returned for “lei” as defined by this API contract.'}, 'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'status': {'type': ['string', 'null'], 'description': 'Normalized endpoint or source status.'}, 'category': {'type': ['string', 'null'], 'description': 'Structured value returned for “category” as defined by this API contract.'}, 'activities': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “activities” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “approvals” as defined by this API contract.'}, 'regulated': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “regulated” as defined by this API contract.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'source_status': {'enum': ['ok', 'unavailable', 'not_queried'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, unavailable, not_queried).'}, 'approval_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “approval count” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/regulatory-approvals API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'language': {'enum': ['fr', 'en'], 'type': 'string', 'default': 'fr', 'description': 'Language used for the generated human-readable output. (default fr; allowed values: fr, en).'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/report API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'language', 'filename', 'mime_type', 'bytes', 'sha256', 'pdf_base64', 'sections', 'generated_at'], 'properties': {'bytes': {'type': 'integer', 'description': 'Structured value returned for “bytes” as defined by this API contract.'}, 'sha256': {'type': 'string', 'description': 'Structured value returned for “sha256” as defined by this API contract.'}, 'filename': {'type': 'string', 'description': 'Structured value returned for “filename” as defined by this API contract.'}, 'language': {'type': 'string', 'description': 'Structured value returned for “language” as defined by this API contract.'}, 'sections': {'type': 'object', 'description': 'Named result sections produced by this aggregator.', 'additionalProperties': True}, 'mime_type': {'type': 'string', 'description': 'Structured value returned for “mime type” as defined by this API contract.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'pdf_base64': {'type': 'string', 'description': 'Structured value returned for “pdf base64” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}}, 'description': 'Structured result returned by the company/fr/report API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/risk API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'company_status', 'risk_level', 'assessment_basis', 'lookback_years', 'coverage_complete', 'signals', 'latest_event', 'events'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'events': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': ['string', 'null'], 'description': 'Structured value returned for “id” as defined by this API contract.'}, 'url': {'type': ['string', 'null'], 'description': 'Structured value returned for “url” as defined by this API contract.'}, 'type': {'enum': ['collective_procedure', 'radiation'], 'type': 'string', 'description': 'Structured value returned for “type” as defined by this API contract. (allowed values: collective_procedure, radiation).'}, 'family': {'type': ['string', 'null'], 'description': 'Structured value returned for “family” as defined by this API contract.'}, 'tribunal': {'type': ['string', 'null'], 'description': 'Structured value returned for “tribunal” as defined by this API contract.'}, 'decision_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “decision date” as defined by this API contract.'}, 'decision_type': {'type': ['string', 'null'], 'description': 'Structured value returned for “decision type” as defined by this API contract.'}, 'publication_date': {'type': 'string', 'description': 'Structured value returned for “publication date” as defined by this API contract.'}}}, 'description': 'Normalized public events returned by the endpoint.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'signals': {'type': 'object', 'required': ['company_closed', 'collective_procedure_events', 'radiation_events'], 'properties': {'company_closed': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “company closed” as defined by this API contract.'}, 'radiation_events': {'type': 'integer', 'description': 'Structured value returned for “radiation events” as defined by this API contract.'}, 'collective_procedure_events': {'type': 'integer', 'description': 'Structured value returned for “collective procedure events” as defined by this API contract.'}}, 'description': 'Structured value returned for “signals” as defined by this API contract.', 'additionalProperties': False}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'risk_level': {'enum': ['low', 'warning', 'high', 'unknown', None], 'type': ['string', 'null'], 'description': 'Explainable public-data risk level produced by this endpoint; it is not an official credit score. (allowed values: low, warning, high, unknown).'}, 'latest_event': {'type': ['object', 'null'], 'description': 'Structured value returned for “latest event” as defined by this API contract.'}, 'company_status': {'type': ['string', 'null'], 'description': 'Current public administrative company status when available.'}, 'lookback_years': {'type': 'integer', 'description': 'Structured value returned for “lookback years” as defined by this API contract.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}, 'assessment_basis': {'type': 'string', 'description': 'Structured value returned for “assessment basis” as defined by this API contract.'}, 'coverage_complete': {'type': ['boolean', 'null'], 'description': 'Whether the checked public-source coverage was sufficient for the endpoint’s stated scope.'}}, 'description': 'Structured result returned by the company/fr/risk API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'language': {'enum': ['fr', 'en'], 'type': 'string', 'default': 'fr', 'description': 'Language used for the generated human-readable output. (default fr; allowed values: fr, en).'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}}, 'description': 'Structured input parameters for the company/fr/risk-reading API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'exists', 'siren', 'name', 'language', 'verdict', 'score', 'confidence', 'narrative', 'strengths', 'alerts', 'evidence', 'generated_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'score': {'type': ['number', 'null'], 'description': 'Normalized score produced by the endpoint; interpretation is defined by the tool description and limitations.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'alerts': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “alerts” as defined by this API contract.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'verdict': {'type': 'string', 'description': 'Normalized endpoint conclusion derived from the checked public data.'}, 'evidence': {'type': 'object', 'description': 'Structured value returned for “evidence” as defined by this API contract.', 'additionalProperties': True}, 'language': {'type': 'string', 'description': 'Structured value returned for “language” as defined by this API contract.'}, 'narrative': {'type': 'string', 'description': 'Structured value returned for “narrative” as defined by this API contract.'}, 'strengths': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “strengths” as defined by this API contract.'}, 'confidence': {'type': ['string', 'null'], 'description': 'Confidence indicator associated with an inferred or derived result.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}}, 'description': 'Structured result returned by the company/fr/risk-reading API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['query'], 'properties': {'limit': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of matching companies to return'}, 'query': {'type': 'string', 'description': 'Company name, legal name, SIREN or SIRET to search for'}, 'postal_code': {'type': 'string', 'description': 'Optional French postal code used to narrow the search'}}, 'description': 'Structured input parameters for the company/fr/search API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['results'], 'properties': {'results': {'type': 'array', 'items': {'type': 'object', 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'status': {'type': ['string', 'null'], 'description': 'Normalized endpoint or source status.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'postal_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “postal code” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}}}, 'description': 'Structured result records returned by the endpoint.'}}, 'description': 'Structured result returned by the company/fr/search API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['activity_code'], 'properties': {'region': {'type': 'string', 'description': 'Optional French region code used to restrict results geographically.'}, 'department': {'type': 'string', 'description': 'Optional French department code used to restrict results geographically.'}, 'activity_code': {'type': 'string', 'pattern': '^[0-9]{2}\\.[0-9]{2}[A-Z]$', 'description': 'French NAF activity code to summarize, in the form 00.00A.'}, 'include_financials': {'type': 'boolean', 'default': False, 'description': 'When true, include the supported public financial sample in the sector statistics. (default false).'}}, 'description': 'Structured input parameters for the company/fr/sector-statistics API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['activity_code', 'department', 'region', 'total_active', 'total_active_is_exact', 'sampled_count', 'sample_limit', 'sample_coverage_percent', 'age_years', 'employee_band_distribution', 'financial_sample_count', 'median_revenue', 'median_net_income', 'generated_at'], 'properties': {'region': {'type': ['string', 'null'], 'description': 'Structured value returned for “region” as defined by this API contract.'}, 'age_years': {'type': 'object', 'required': ['min', 'median', 'max'], 'properties': {'max': {'type': ['integer', 'null'], 'description': 'Structured value returned for “max” as defined by this API contract.'}, 'min': {'type': ['integer', 'null'], 'description': 'Structured value returned for “min” as defined by this API contract.'}, 'median': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “median” as defined by this API contract.'}}, 'description': 'Structured value returned for “age years” as defined by this API contract.', 'additionalProperties': False}, 'department': {'type': ['string', 'null'], 'description': 'Structured value returned for “department” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'sample_limit': {'type': 'integer', 'description': 'Structured value returned for “sample limit” as defined by this API contract.'}, 'total_active': {'type': 'integer', 'description': 'Structured value returned for “total active” as defined by this API contract.'}, 'activity_code': {'type': 'string', 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'sampled_count': {'type': 'integer', 'description': 'Structured value returned for “sampled count” as defined by this API contract.'}, 'median_revenue': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “median revenue” as defined by this API contract.'}, 'median_net_income': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “median net income” as defined by this API contract.'}, 'total_active_is_exact': {'type': 'boolean', 'description': 'Structured value returned for “total active is exact” as defined by this API contract.'}, 'financial_sample_count': {'type': 'integer', 'description': 'Structured value returned for “financial sample count” as defined by this API contract.'}, 'sample_coverage_percent': {'type': 'number', 'description': 'Structured value returned for “sample coverage percent” as defined by this API contract.'}, 'employee_band_distribution': {'type': 'array', 'items': {'type': 'object', 'required': ['code', 'count'], 'properties': {'code': {'type': 'string', 'description': 'Structured value returned for “code” as defined by this API contract.'}, 'count': {'type': 'integer', 'description': 'Structured value returned for “count” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “employee band distribution” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/sector-statistics API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/signals API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'siren', 'name', 'lookback_days', 'checked_at', 'signals_count', 'signals', 'coverage'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'signals': {'type': 'array', 'items': {'type': 'object', 'required': ['type', 'date', 'importance', 'explanation', 'source_data', 'sources'], 'properties': {'date': {'type': ['string', 'null'], 'description': 'Structured value returned for “date” as defined by this API contract.'}, 'type': {'enum': ['INSOLVENCY', 'REVENUE_DROP', 'FAST_GROWTH', 'NEW_FINANCIAL_STATEMENT', 'NEW_PUBLIC_CONTRACT', 'NEW_CERTIFICATION', 'COMPANY_CLOSED'], 'type': 'string', 'description': 'Structured value returned for “type” as defined by this API contract. (allowed values: INSOLVENCY, REVENUE_DROP, FAST_GROWTH, NEW_FINANCIAL_STATEMENT, NEW_PUBLIC_CONTRACT, NEW_CERTIFICATION, COMPANY_CLOSED).'}, 'sources': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Public data sources used or checked for this result.'}, 'importance': {'enum': ['low', 'medium', 'high'], 'type': 'string', 'description': 'Structured value returned for “importance” as defined by this API contract. (allowed values: low, medium, high).'}, 'explanation': {'type': 'string', 'description': 'Structured value returned for “explanation” as defined by this API contract.'}, 'source_data': {'type': 'object', 'description': 'Structured value returned for “source data” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “signals” as defined by this API contract.'}, 'coverage': {'type': 'array', 'items': {'type': 'object', 'required': ['service', 'status'], 'properties': {'status': {'type': 'string', 'description': 'Normalized endpoint or source status.'}, 'service': {'type': 'string', 'description': 'Structured value returned for “service” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Coverage information describing which underlying services or sources were available.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'lookback_days': {'type': 'integer', 'description': 'Structured value returned for “lookback days” as defined by this API contract.'}, 'signals_count': {'type': 'integer', 'description': 'Structured value returned for “signals count” as defined by this API contract.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/signals API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['siret'], 'properties': {'limit': {'type': 'integer', 'default': 50, 'maximum': 100, 'minimum': 1, 'description': 'Maximum predecessor and successor links per direction, up to 100'}, 'siret': {'type': 'string', 'pattern': '^[0-9]{14}$', 'description': '14-digit French SIRET'}, 'successors_cursor': {'type': 'string', 'default': '*', 'maxLength': 4096, 'minLength': 1, 'description': 'Opaque cursor returned by successors_next_cursor; omit on the first call'}, 'predecessors_cursor': {'type': 'string', 'default': '*', 'maxLength': 4096, 'minLength': 1, 'description': 'Opaque cursor returned by predecessors_next_cursor; omit on the first call'}}, 'description': 'Structured input parameters for the company/fr/successions API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['siret', 'siren', 'predecessors_count', 'successors_count', 'predecessors_returned_count', 'successors_returned_count', 'predecessors_cursor', 'successors_cursor', 'predecessors_next_cursor', 'successors_next_cursor', 'predecessors_truncated', 'successors_truncated', 'predecessors', 'successors'], 'properties': {'siren': {'type': 'string', 'description': 'Normalized 9-digit French SIREN when available.'}, 'siret': {'type': 'string', 'description': 'Normalized 14-digit French SIRET when available.'}, 'successors': {'type': 'array', 'items': {'type': 'object', 'required': ['siret', 'effective_date', 'headquarters_transfer', 'economic_continuity', 'last_processed_at'], 'properties': {'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'effective_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “effective date” as defined by this API contract.'}, 'last_processed_at': {'type': ['string', 'null'], 'description': 'Structured value returned for “last processed at” as defined by this API contract.'}, 'economic_continuity': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “economic continuity” as defined by this API contract.'}, 'headquarters_transfer': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “headquarters transfer” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “successors” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'predecessors': {'type': 'array', 'items': {'type': 'object', 'required': ['siret', 'effective_date', 'headquarters_transfer', 'economic_continuity', 'last_processed_at'], 'properties': {'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'effective_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “effective date” as defined by this API contract.'}, 'last_processed_at': {'type': ['string', 'null'], 'description': 'Structured value returned for “last processed at” as defined by this API contract.'}, 'economic_continuity': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “economic continuity” as defined by this API contract.'}, 'headquarters_transfer': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “headquarters transfer” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “predecessors” as defined by this API contract.'}, 'successors_count': {'type': 'integer', 'description': 'Structured value returned for “successors count” as defined by this API contract.'}, 'successors_cursor': {'type': 'string', 'description': 'Structured value returned for “successors cursor” as defined by this API contract.'}, 'predecessors_count': {'type': 'integer', 'description': 'Structured value returned for “predecessors count” as defined by this API contract.'}, 'predecessors_cursor': {'type': 'string', 'description': 'Structured value returned for “predecessors cursor” as defined by this API contract.'}, 'successors_truncated': {'type': 'boolean', 'description': 'Structured value returned for “successors truncated” as defined by this API contract.'}, 'predecessors_truncated': {'type': 'boolean', 'description': 'Structured value returned for “predecessors truncated” as defined by this API contract.'}, 'successors_next_cursor': {'type': ['string', 'null'], 'description': 'Structured value returned for “successors next cursor” as defined by this API contract.'}, 'predecessors_next_cursor': {'type': ['string', 'null'], 'description': 'Structured value returned for “predecessors next cursor” as defined by this API contract.'}, 'successors_returned_count': {'type': 'integer', 'description': 'Structured value returned for “successors returned count” as defined by this API contract.'}, 'predecessors_returned_count': {'type': 'integer', 'description': 'Structured value returned for “predecessors returned count” as defined by this API contract.'}}, 'description': 'Structured result returned by the company/fr/successions API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'iban': {'type': 'string', 'description': 'IBAN supplied for structural validation or supplier consistency checks.'}, 'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'French company identifier: 9-digit SIREN or 14-digit SIRET.'}, 'vat_number': {'type': 'string', 'description': 'Optional or required VAT identifier used by this validation or consistency check.'}}, 'description': 'Structured input parameters for the company/fr/supplier-verification API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'siren', 'name', 'verdict', 'checks', 'checked_at'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'checks': {'type': 'object', 'description': 'Structured value returned for “checks” as defined by this API contract.', 'additionalProperties': True}, 'verdict': {'type': 'string', 'description': 'Normalized endpoint conclusion derived from the checked public data.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}}, 'description': 'Structured result returned by the company/fr/supplier-verification API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': '9-digit SIREN or 14-digit SIRET'}}, 'description': 'Structured input parameters for the company/fr/verify API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['identifier', 'identifier_type', 'exists', 'active', 'siren', 'siret', 'name', 'activity_code', 'address', 'postal_code', 'city'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siren': {'type': ['string', 'null'], 'description': 'Normalized 9-digit French SIREN when available.'}, 'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'active': {'type': ['boolean', 'null'], 'description': 'Current public administrative active status when available.'}, 'exists': {'type': 'boolean', 'description': 'Whether the requested company or public record was found in the checked source.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'identifier': {'type': 'string', 'description': 'Identifier supplied for the request, echoed in normalized form when applicable.'}, 'postal_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “postal code” as defined by this API contract.'}, 'activity_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “activity code” as defined by this API contract.'}, 'identifier_type': {'enum': ['siren', 'siret'], 'type': 'string', 'description': 'Normalized identifier type, such as SIREN or SIRET when applicable. (allowed values: siren, siret).'}}, 'description': 'Structured result returned by the company/fr/verify API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'minLength': 2, 'description': 'Person or organization name to compare with the supported public sanctions and asset-freeze lists. (minimum length 2; maximum length 200).'}, 'threshold': {'type': 'integer', 'default': 85, 'maximum': 100, 'minimum': 50, 'description': 'Minimum fuzzy-match score accepted as a candidate public-list match. (minimum 50; maximum 100; default 85).'}}, 'description': 'Structured input parameters for the compliance/name-screen API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['name', 'threshold', 'status', 'match_count', 'matches', 'sources', 'checked_at'], 'properties': {'name': {'type': 'string', 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'status': {'type': 'string', 'description': 'Normalized endpoint or source status.'}, 'matches': {'type': 'array', 'items': {'type': 'object', 'required': ['source', 'name', 'score', 'reference', 'type'], 'properties': {'name': {'type': 'string', 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'type': {'type': ['string', 'null'], 'description': 'Structured value returned for “type” as defined by this API contract.'}, 'score': {'type': 'integer', 'description': 'Normalized score produced by the endpoint; interpretation is defined by the tool description and limitations.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'reference': {'type': ['string', 'null'], 'description': 'Structured value returned for “reference” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Candidate public-list or source matches returned by the endpoint.'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['source', 'status', 'records_scanned', 'publication_date'], 'properties': {'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'status': {'type': 'string', 'description': 'Normalized endpoint or source status.'}, 'records_scanned': {'type': 'integer', 'description': 'Structured value returned for “records scanned” as defined by this API contract.'}, 'publication_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “publication date” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Public data sources used or checked for this result.'}, 'threshold': {'type': 'integer', 'description': 'Structured value returned for “threshold” as defined by this API contract.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'match_count': {'type': 'integer', 'description': 'Number of candidate matches returned by the screening operation.'}}, 'description': 'Structured result returned by the compliance/name-screen API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['endpoint'], 'properties': {'endpoint': {'enum': ['company/fr/aids', 'company/fr/benchmark', 'company/fr/certifications', 'company/fr/changes', 'company/fr/closures', 'company/fr/compare', 'company/fr/compliance', 'company/fr/default-score', 'company/fr/director-mandates', 'company/fr/directors', 'company/fr/e-invoice', 'company/fr/establishments', 'company/fr/events', 'company/fr/financials', 'company/fr/history', 'company/fr/industrial-risk', 'company/fr/intelligence', 'company/fr/invoice-check', 'company/fr/kyb-batch', 'company/fr/legal-announcements-search', 'company/fr/lobbying', 'company/fr/nearby', 'company/fr/new', 'company/fr/opportunities', 'company/fr/payment-context', 'company/fr/peers', 'company/fr/profile', 'company/fr/prospecting', 'company/fr/public-contract-competitors', 'company/fr/public-contracts', 'company/fr/public-contracts-eu', 'company/fr/regulatory-approvals', 'company/fr/report', 'company/fr/risk', 'company/fr/risk-reading', 'company/fr/search', 'company/fr/sector-statistics', 'company/fr/signals', 'company/fr/successions', 'company/fr/supplier-verification', 'company/fr/verify', 'compliance/name-screen', 'iban/validate', 'procurement/fr/awards', 'procurement/fr/buyer-profile', 'procurement/fr/deadlines', 'procurement/fr/market', 'procurement/fr/search', 'procurement/fr/trends', 'vat/eu/validate'], 'type': 'string', 'pattern': '^[a-z0-9]+(?:/[a-z0-9][a-z0-9_-]*)+$', 'maxLength': 128, 'description': 'Canonical published HelpMyAgent endpoint slug. Accepted values are restricted to the live published catalogue.'}}, 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'additionalProperties': True}
Esquema de entrada
{'type': 'object', 'required': ['iban'], 'properties': {'iban': {'type': 'string', 'maxLength': 34, 'minLength': 15, 'description': 'IBAN to normalize and validate structurally, including the ISO 13616 mod-97 checksum. (minimum length 15; maximum length 34).'}}, 'description': 'Structured input parameters for the iban/validate API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['iban', 'country_code', 'structure_valid', 'checksum_valid', 'valid', 'expected_length', 'bank_code', 'branch_code', 'account_number', 'rib_key', 'bic', 'bank_name', 'checked_at'], 'properties': {'bic': {'type': ['string', 'null'], 'description': 'Structured value returned for “bic” as defined by this API contract.'}, 'iban': {'type': 'string', 'description': 'Structured value returned for “iban” as defined by this API contract.'}, 'valid': {'type': 'boolean', 'description': 'Whether the supplied identifier passed the endpoint’s validation rules.'}, 'rib_key': {'type': ['string', 'null'], 'description': 'Structured value returned for “rib key” as defined by this API contract.'}, 'bank_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “bank code” as defined by this API contract.'}, 'bank_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “bank name” as defined by this API contract.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'branch_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “branch code” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'country_code': {'type': 'string', 'description': 'Structured value returned for “country code” as defined by this API contract.'}, 'account_number': {'type': ['string', 'null'], 'description': 'Structured value returned for “account number” as defined by this API contract.'}, 'checksum_valid': {'type': 'boolean', 'description': 'Structured value returned for “checksum valid” as defined by this API contract.'}, 'expected_length': {'type': ['integer', 'null'], 'description': 'Structured value returned for “expected length” as defined by this API contract.'}, 'structure_valid': {'type': 'boolean', 'description': 'Structured value returned for “structure valid” as defined by this API contract.'}}, 'description': 'Structured result returned by the iban/validate API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['categories'], 'properties': {'categories': {'type': 'array', 'items': {'type': 'object'}, 'description': 'Published HelpMyAgent API categories with endpoint counts and documentation links.'}}}
Esquema de entrada
{'type': 'object', 'properties': {'buyer': {'type': 'string', 'maxLength': 200, 'minLength': 2, 'description': 'Public-buyer name or identifier used to restrict procurement results. (minimum length 2; maximum length 200).'}, 'limit': {'type': 'integer', 'default': 20, 'maximum': 50, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 50; default 20).'}, 'holder': {'type': 'string', 'pattern': '^[0-9]{9}([0-9]{5})?$', 'description': 'Optional value for “holder” as defined by this API contract.'}, 'date_to': {'type': 'string', 'format': 'date', 'description': 'Optional value for “date to” as defined by this API contract.'}, 'date_from': {'type': 'string', 'format': 'date', 'description': 'Optional value for “date from” as defined by this API contract.'}, 'cpv_prefix': {'type': 'string', 'pattern': '^[0-9]{1,8}$', 'description': 'Optional CPV prefix used to restrict procurement records to a purchasing segment.'}, 'department': {'type': 'string', 'pattern': '^(?:[0-9]{2,3}|2A|2B)$', 'description': 'Optional French department code used to restrict results geographically.'}, 'max_amount': {'type': 'number', 'minimum': 0, 'description': 'Optional value for “max amount” as defined by this API contract. (minimum 0).'}, 'min_amount': {'type': 'number', 'minimum': 0, 'description': 'Optional value for “min amount” as defined by this API contract. (minimum 0).'}}, 'description': 'Structured input parameters for the procurement/fr/awards API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['filters', 'source_status', 'total_count', 'returned_count', 'truncated', 'awards', 'generated_at'], 'properties': {'awards': {'type': 'array', 'items': {'type': 'object', 'required': ['contract_id', 'object', 'nature', 'procedure', 'cpv', 'amount', 'duration_months', 'notification_date', 'publication_date', 'buyer_siret', 'buyer_name', 'holder_sirets', 'execution_location_code', 'execution_location_type', 'execution_location_name'], 'properties': {'cpv': {'type': ['string', 'null'], 'description': 'Structured value returned for “cpv” as defined by this API contract.'}, 'amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “amount” as defined by this API contract.'}, 'nature': {'type': ['string', 'null'], 'description': 'Structured value returned for “nature” as defined by this API contract.'}, 'object': {'type': ['string', 'null'], 'description': 'Structured value returned for “object” as defined by this API contract.'}, 'procedure': {'type': ['string', 'null'], 'description': 'Structured value returned for “procedure” as defined by this API contract.'}, 'buyer_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer name” as defined by this API contract.'}, 'buyer_siret': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer siret” as defined by this API contract.'}, 'contract_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “contract id” as defined by this API contract.'}, 'holder_sirets': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “holder sirets” as defined by this API contract.'}, 'duration_months': {'type': ['integer', 'null'], 'description': 'Structured value returned for “duration months” as defined by this API contract.'}, 'publication_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “publication date” as defined by this API contract.'}, 'notification_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “notification date” as defined by this API contract.'}, 'execution_location_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “execution location code” as defined by this API contract.'}, 'execution_location_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “execution location name” as defined by this API contract.'}, 'execution_location_type': {'type': ['string', 'null'], 'description': 'Structured value returned for “execution location type” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “awards” as defined by this API contract.'}, 'filters': {'type': 'object', 'required': ['cpv_prefix', 'department', 'buyer', 'holder', 'date_from', 'date_to', 'min_amount', 'max_amount'], 'properties': {'buyer': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer” as defined by this API contract.'}, 'holder': {'type': ['string', 'null'], 'description': 'Structured value returned for “holder” as defined by this API contract.'}, 'date_to': {'type': ['string', 'null'], 'description': 'Structured value returned for “date to” as defined by this API contract.'}, 'date_from': {'type': ['string', 'null'], 'description': 'Structured value returned for “date from” as defined by this API contract.'}, 'cpv_prefix': {'type': ['string', 'null'], 'description': 'Structured value returned for “cpv prefix” as defined by this API contract.'}, 'department': {'type': ['string', 'null'], 'description': 'Structured value returned for “department” as defined by this API contract.'}, 'max_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “max amount” as defined by this API contract.'}, 'min_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “min amount” as defined by this API contract.'}}, 'description': 'Structured value returned for “filters” as defined by this API contract.', 'additionalProperties': False}, 'truncated': {'type': ['boolean', 'null'], 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'total_count': {'type': ['integer', 'null'], 'description': 'Total number of matching records reported by the source or endpoint.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'source_status': {'enum': ['ok', 'unavailable'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, unavailable).'}, 'returned_count': {'type': ['integer', 'null'], 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the procurement/fr/awards API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['buyer'], 'properties': {'buyer': {'type': 'string', 'maxLength': 200, 'minLength': 2, 'description': 'French public-buyer name or SIRET used to build the procurement profile. (minimum length 2; maximum length 200).'}, 'limit': {'type': 'integer', 'default': 100, 'maximum': 100, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 100; default 100).'}}, 'description': 'Structured input parameters for the procurement/fr/buyer-profile API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['query', 'source_status', 'buyer_siret', 'buyer_name', 'total_count', 'sampled_count', 'sampled_amount', 'latest_notification_date', 'by_year', 'top_cpv', 'top_suppliers', 'generated_at'], 'properties': {'query': {'type': 'string', 'description': 'Structured value returned for “query” as defined by this API contract.'}, 'by_year': {'type': 'array', 'items': {'type': 'object', 'required': ['year', 'contracts_count'], 'properties': {'year': {'type': 'string', 'description': 'Structured value returned for “year” as defined by this API contract.'}, 'contracts_count': {'type': 'integer', 'description': 'Structured value returned for “contracts count” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “by year” as defined by this API contract.'}, 'top_cpv': {'type': 'array', 'items': {'type': 'object', 'required': ['cpv', 'contracts_count'], 'properties': {'cpv': {'type': 'string', 'description': 'Structured value returned for “cpv” as defined by this API contract.'}, 'contracts_count': {'type': 'integer', 'description': 'Structured value returned for “contracts count” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “top cpv” as defined by this API contract.'}, 'buyer_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer name” as defined by this API contract.'}, 'buyer_siret': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer siret” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'total_count': {'type': ['integer', 'null'], 'description': 'Total number of matching records reported by the source or endpoint.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'sampled_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “sampled count” as defined by this API contract.'}, 'source_status': {'enum': ['ok', 'unavailable'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, unavailable).'}, 'top_suppliers': {'type': 'array', 'items': {'type': 'object', 'required': ['siren', 'contracts_count'], 'properties': {'siren': {'type': 'string', 'description': 'Normalized 9-digit French SIREN when available.'}, 'contracts_count': {'type': 'integer', 'description': 'Structured value returned for “contracts count” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “top suppliers” as defined by this API contract.'}, 'sampled_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “sampled amount” as defined by this API contract.'}, 'latest_notification_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “latest notification date” as defined by this API contract.'}}, 'description': 'Structured result returned by the procurement/fr/buyer-profile API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 25, 'maximum': 50, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 50; default 25).'}, 'cpv_prefix': {'type': 'string', 'pattern': '^[0-9]{1,8}$', 'description': 'Optional CPV code prefix used to restrict public-contract expiry estimates to a procurement segment.'}, 'department': {'type': 'string', 'description': 'Optional French department code used to restrict results geographically.'}, 'max_months': {'type': 'integer', 'default': 18, 'maximum': 60, 'minimum': 1, 'description': 'Maximum number of months from now before the estimated contract end date. (minimum 1; maximum 60; default 18).'}, 'min_months': {'type': 'integer', 'default': 0, 'maximum': 60, 'minimum': 0, 'description': 'Minimum number of months from now before the estimated contract end date. (minimum 0; maximum 60; default 0).'}}, 'description': 'Structured input parameters for the procurement/fr/deadlines API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['cpv_prefix', 'department', 'min_months', 'max_months', 'source_status', 'returned_count', 'contracts', 'generated_at'], 'properties': {'contracts': {'type': 'array', 'items': {'type': 'object', 'required': ['contract_id', 'object', 'cpv', 'buyer_siret', 'buyer_name', 'holder_sirets', 'amount', 'notification_date', 'duration_months', 'effective_duration_months', 'duration_source', 'modification_detected', 'modification_id', 'modification_date', 'modification_object', 'estimated_end_date', 'estimated_end_confidence', 'months_until_end', 'execution_location'], 'properties': {'cpv': {'type': ['string', 'null'], 'description': 'Structured value returned for “cpv” as defined by this API contract.'}, 'amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “amount” as defined by this API contract.'}, 'object': {'type': ['string', 'null'], 'description': 'Structured value returned for “object” as defined by this API contract.'}, 'buyer_name': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer name” as defined by this API contract.'}, 'buyer_siret': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer siret” as defined by this API contract.'}, 'contract_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “contract id” as defined by this API contract.'}, 'holder_sirets': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “holder sirets” as defined by this API contract.'}, 'duration_months': {'type': 'integer', 'description': 'Structured value returned for “duration months” as defined by this API contract.'}, 'duration_source': {'enum': ['decp_initial', 'decp_modification'], 'type': 'string', 'description': 'Structured value returned for “duration source” as defined by this API contract. (allowed values: decp_initial, decp_modification).'}, 'modification_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “modification id” as defined by this API contract.'}, 'months_until_end': {'type': 'integer', 'description': 'Structured value returned for “months until end” as defined by this API contract.'}, 'modification_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “modification date” as defined by this API contract.'}, 'notification_date': {'type': 'string', 'description': 'Structured value returned for “notification date” as defined by this API contract.'}, 'estimated_end_date': {'type': 'string', 'description': 'Structured value returned for “estimated end date” as defined by this API contract.'}, 'execution_location': {'type': ['string', 'null'], 'description': 'Structured value returned for “execution location” as defined by this API contract.'}, 'modification_object': {'type': ['string', 'null'], 'description': 'Structured value returned for “modification object” as defined by this API contract.'}, 'modification_detected': {'type': 'boolean', 'description': 'Structured value returned for “modification detected” as defined by this API contract.'}, 'estimated_end_confidence': {'enum': ['low', 'medium', 'high'], 'type': 'string', 'description': 'Structured value returned for “estimated end confidence” as defined by this API contract. (allowed values: low, medium, high).'}, 'effective_duration_months': {'type': 'integer', 'description': 'Structured value returned for “effective duration months” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Normalized public-contract records returned by the endpoint.'}, 'cpv_prefix': {'type': ['string', 'null'], 'description': 'Structured value returned for “cpv prefix” as defined by this API contract.'}, 'department': {'type': ['string', 'null'], 'description': 'Structured value returned for “department” as defined by this API contract.'}, 'max_months': {'type': 'integer', 'description': 'Structured value returned for “max months” as defined by this API contract.'}, 'min_months': {'type': 'integer', 'description': 'Structured value returned for “min months” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'source_status': {'enum': ['ok', 'unavailable'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, unavailable).'}, 'returned_count': {'type': ['integer', 'null'], 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the procurement/fr/deadlines API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'buyer': {'type': 'string', 'maxLength': 200, 'minLength': 2, 'description': 'Public-buyer name or identifier used to restrict procurement results. (minimum length 2; maximum length 200).'}, 'cpv_prefix': {'type': 'string', 'pattern': '^[0-9]{1,8}$', 'description': 'Optional CPV prefix used to restrict procurement records to a purchasing segment.'}, 'department': {'type': 'string', 'pattern': '^(?:[0-9]{2,3}|2A|2B)$', 'description': 'Optional French department code used to restrict results geographically.'}, 'lookback_months': {'type': 'integer', 'default': 12, 'maximum': 60, 'minimum': 1, 'description': 'Optional value for “lookback months” as defined by this API contract. (minimum 1; maximum 60; default 12).'}}, 'description': 'Structured input parameters for the procurement/fr/market API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['filters', 'lookback_months', 'source_status', 'summary', 'top_buyers', 'top_cpv', 'top_suppliers_in_latest_sample', 'supplier_sampled_count', 'supplier_sample_coverage_percent', 'generated_at'], 'properties': {'filters': {'type': 'object', 'required': ['cpv_prefix', 'department', 'buyer', 'date_from', 'date_to'], 'properties': {'buyer': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer” as defined by this API contract.'}, 'date_to': {'type': ['string', 'null'], 'description': 'Structured value returned for “date to” as defined by this API contract.'}, 'date_from': {'type': ['string', 'null'], 'description': 'Structured value returned for “date from” as defined by this API contract.'}, 'cpv_prefix': {'type': ['string', 'null'], 'description': 'Structured value returned for “cpv prefix” as defined by this API contract.'}, 'department': {'type': ['string', 'null'], 'description': 'Structured value returned for “department” as defined by this API contract.'}}, 'description': 'Structured value returned for “filters” as defined by this API contract.', 'additionalProperties': False}, 'summary': {'type': 'object', 'required': ['contracts_count', 'total_amount', 'average_amount', 'median_amount', 'minimum_amount', 'maximum_amount'], 'properties': {'total_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “total amount” as defined by this API contract.'}, 'median_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “median amount” as defined by this API contract.'}, 'average_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “average amount” as defined by this API contract.'}, 'maximum_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “maximum amount” as defined by this API contract.'}, 'minimum_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “minimum amount” as defined by this API contract.'}, 'contracts_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “contracts count” as defined by this API contract.'}}, 'description': 'Compact derived summary of the returned records.', 'additionalProperties': False}, 'top_cpv': {'type': 'array', 'items': {'type': 'object', 'required': ['cpv', 'contracts_count', 'total_amount'], 'properties': {'cpv': {'type': ['string', 'null'], 'description': 'Structured value returned for “cpv” as defined by this API contract.'}, 'total_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “total amount” as defined by this API contract.'}, 'contracts_count': {'type': 'integer', 'description': 'Structured value returned for “contracts count” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “top cpv” as defined by this API contract.'}, 'top_buyers': {'type': 'array', 'items': {'type': 'object', 'required': ['siret', 'name', 'contracts_count', 'total_amount'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'siret': {'type': ['string', 'null'], 'description': 'Normalized 14-digit French SIRET when available.'}, 'total_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “total amount” as defined by this API contract.'}, 'contracts_count': {'type': 'integer', 'description': 'Structured value returned for “contracts count” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “top buyers” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'source_status': {'enum': ['ok', 'partial', 'unavailable'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, partial, unavailable).'}, 'lookback_months': {'type': 'integer', 'description': 'Structured value returned for “lookback months” as defined by this API contract.'}, 'supplier_sampled_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “supplier sampled count” as defined by this API contract.'}, 'top_suppliers_in_latest_sample': {'type': 'array', 'items': {'type': 'object', 'required': ['siren', 'contracts_count_in_sample'], 'properties': {'siren': {'type': 'string', 'description': 'Normalized 9-digit French SIREN when available.'}, 'contracts_count_in_sample': {'type': 'integer', 'description': 'Structured value returned for “contracts count in sample” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “top suppliers in latest sample” as defined by this API contract.'}, 'supplier_sample_coverage_percent': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “supplier sample coverage percent” as defined by this API contract.'}}, 'description': 'Structured result returned by the procurement/fr/market API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'buyer': {'type': 'string', 'minLength': 2, 'description': 'Public buyer name to search for'}, 'limit': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of open tenders to return'}, 'query': {'type': 'string', 'minLength': 2, 'description': 'Keywords to search in currently open public procurement notices'}, 'department': {'type': 'string', 'description': 'French department code'}, 'deadline_after': {'type': 'string', 'format': 'date', 'description': 'Only return tenders whose deadline is on or after this YYYY-MM-DD date'}}, 'description': 'Structured input parameters for the procurement/fr/search API. At least one of query, department, or buyer must be provided.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['query', 'department', 'buyer', 'deadline_after', 'total_count', 'returned_count', 'truncated', 'tenders'], 'properties': {'buyer': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer” as defined by this API contract.'}, 'query': {'type': ['string', 'null'], 'description': 'Structured value returned for “query” as defined by this API contract.'}, 'tenders': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': ['string', 'null'], 'description': 'Structured value returned for “id” as defined by this API contract.'}, 'url': {'type': ['string', 'null'], 'description': 'Structured value returned for “url” as defined by this API contract.'}, 'buyer': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer” as defined by this API contract.'}, 'object': {'type': ['string', 'null'], 'description': 'Structured value returned for “object” as defined by this API contract.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'criteria': {'type': 'array', 'description': 'Structured value returned for “criteria” as defined by this API contract.'}, 'deadline': {'type': ['string', 'null'], 'description': 'Structured value returned for “deadline” as defined by this API contract.'}, 'cpv_codes': {'type': 'array', 'description': 'Structured value returned for “cpv codes” as defined by this API contract.'}, 'procedure': {'type': ['string', 'null'], 'description': 'Structured value returned for “procedure” as defined by this API contract.'}, 'departments': {'type': 'array', 'description': 'Structured value returned for “departments” as defined by this API contract.'}, 'descriptors': {'type': 'array', 'description': 'Structured value returned for “descriptors” as defined by this API contract.'}, 'notice_type': {'type': ['string', 'null'], 'description': 'Structured value returned for “notice type” as defined by this API contract.'}, 'source_type': {'type': 'string', 'description': 'Structured value returned for “source type” as defined by this API contract.'}, 'market_types': {'type': 'array', 'description': 'Structured value returned for “market types” as defined by this API contract.'}, 'days_remaining': {'type': ['integer', 'null'], 'description': 'Structured value returned for “days remaining” as defined by this API contract.'}, 'procedure_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “procedure code” as defined by this API contract.'}, 'publication_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “publication date” as defined by this API contract.'}}}, 'description': 'Normalized open public-procurement notices returned by the endpoint.'}, 'truncated': {'type': 'boolean', 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'department': {'type': ['string', 'null'], 'description': 'Structured value returned for “department” as defined by this API contract.'}, 'total_count': {'type': 'integer', 'description': 'Total number of matching records reported by the source or endpoint.'}, 'deadline_after': {'type': ['string', 'null'], 'description': 'Structured value returned for “deadline after” as defined by this API contract.'}, 'returned_count': {'type': 'integer', 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the procurement/fr/search API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'buyer': {'type': 'string', 'maxLength': 200, 'minLength': 2, 'description': 'Public-buyer name or identifier used to restrict procurement results. (minimum length 2; maximum length 200).'}, 'cpv_prefix': {'type': 'string', 'pattern': '^[0-9]{1,8}$', 'description': 'Optional CPV prefix used to restrict procurement records to a purchasing segment.'}, 'department': {'type': 'string', 'pattern': '^(?:[0-9]{2,3}|2A|2B)$', 'description': 'Optional French department code used to restrict results geographically.'}, 'granularity': {'enum': ['month', 'year'], 'type': 'string', 'default': 'month', 'description': 'Optional value for “granularity” as defined by this API contract. (default month; allowed values: month, year).'}, 'lookback_months': {'type': 'integer', 'default': 24, 'maximum': 60, 'minimum': 1, 'description': 'Optional value for “lookback months” as defined by this API contract. (minimum 1; maximum 60; default 24).'}}, 'description': 'Structured input parameters for the procurement/fr/trends API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['filters', 'lookback_months', 'granularity', 'source_status', 'periods_count', 'latest_period_contracts_change_percent', 'series', 'generated_at'], 'properties': {'series': {'type': 'array', 'items': {'type': 'object', 'required': ['period', 'contracts_count', 'total_amount', 'average_amount'], 'properties': {'period': {'type': 'string', 'description': 'Structured value returned for “period” as defined by this API contract.'}, 'total_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “total amount” as defined by this API contract.'}, 'average_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “average amount” as defined by this API contract.'}, 'contracts_count': {'type': 'integer', 'description': 'Structured value returned for “contracts count” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “series” as defined by this API contract.'}, 'filters': {'type': 'object', 'required': ['cpv_prefix', 'department', 'buyer', 'date_from', 'date_to'], 'properties': {'buyer': {'type': ['string', 'null'], 'description': 'Structured value returned for “buyer” as defined by this API contract.'}, 'date_to': {'type': ['string', 'null'], 'description': 'Structured value returned for “date to” as defined by this API contract.'}, 'date_from': {'type': ['string', 'null'], 'description': 'Structured value returned for “date from” as defined by this API contract.'}, 'cpv_prefix': {'type': ['string', 'null'], 'description': 'Structured value returned for “cpv prefix” as defined by this API contract.'}, 'department': {'type': ['string', 'null'], 'description': 'Structured value returned for “department” as defined by this API contract.'}}, 'description': 'Structured value returned for “filters” as defined by this API contract.', 'additionalProperties': False}, 'granularity': {'enum': ['month', 'year'], 'type': 'string', 'description': 'Structured value returned for “granularity” as defined by this API contract. (allowed values: month, year).'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'periods_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “periods count” as defined by this API contract.'}, 'source_status': {'enum': ['ok', 'unavailable'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok, unavailable).'}, 'lookback_months': {'type': 'integer', 'description': 'Structured value returned for “lookback months” as defined by this API contract.'}, 'latest_period_contracts_change_percent': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latest period contracts change percent” as defined by this API contract.'}}, 'description': 'Structured result returned by the procurement/fr/trends API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 10, 'maximum': 50, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 50; default 10).'}, 'address': {'type': 'string', 'maxLength': 250, 'minLength': 5, 'description': 'Optional value for “address” as defined by this API contract. (minimum length 5; maximum length 250).'}, 'code_insee': {'type': 'string', 'pattern': '^(?:[0-9]{5}|2[ABab][0-9]{3})$', 'description': 'Optional value for “code insee” as defined by this API contract.'}}, 'description': 'Structured input parameters for the real-estate/fr/dpe API. At least one of address or code_insee must be provided.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['location', 'source_status', 'total_count', 'returned_count', 'truncated', 'dpe', 'generated_at'], 'properties': {'dpe': {'type': 'array', 'items': {'type': 'object', 'required': ['numero_dpe', 'etiquette_dpe', 'etiquette_ges', 'date_etablissement', 'date_fin_validite', 'surface_habitable_m2', 'annee_construction', 'type_batiment', 'adresse', 'code_postal', 'code_insee', 'commune', 'consommation_kwh_ep_m2_an', 'emission_ges_kgco2_m2_an'], 'properties': {'adresse': {'type': ['string', 'null'], 'description': 'Structured value returned for “adresse” as defined by this API contract.'}, 'commune': {'type': ['string', 'null'], 'description': 'Structured value returned for “commune” as defined by this API contract.'}, 'code_insee': {'type': ['string', 'null'], 'description': 'Structured value returned for “code insee” as defined by this API contract.'}, 'numero_dpe': {'type': ['string', 'null'], 'description': 'Structured value returned for “numero dpe” as defined by this API contract.'}, 'code_postal': {'type': ['string', 'null'], 'description': 'Structured value returned for “code postal” as defined by this API contract.'}, 'etiquette_dpe': {'type': ['string', 'null'], 'description': 'Structured value returned for “etiquette dpe” as defined by this API contract.'}, 'etiquette_ges': {'type': ['string', 'null'], 'description': 'Structured value returned for “etiquette ges” as defined by this API contract.'}, 'type_batiment': {'type': ['string', 'null'], 'description': 'Structured value returned for “type batiment” as defined by this API contract.'}, 'date_fin_validite': {'type': ['string', 'null'], 'description': 'Structured value returned for “date fin validite” as defined by this API contract.'}, 'annee_construction': {'type': ['integer', 'null'], 'description': 'Structured value returned for “annee construction” as defined by this API contract.'}, 'date_etablissement': {'type': ['string', 'null'], 'description': 'Structured value returned for “date etablissement” as defined by this API contract.'}, 'surface_habitable_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “surface habitable m2” as defined by this API contract.'}, 'emission_ges_kgco2_m2_an': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “emission ges kgco2 m2 an” as defined by this API contract.'}, 'consommation_kwh_ep_m2_an': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “consommation kwh ep m2 an” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “dpe” as defined by this API contract.'}, 'location': {'type': 'object', 'required': ['code_insee', 'address', 'normalized_address', 'postcode', 'city', 'ban_id', 'geocoding_score', 'longitude', 'latitude'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'ban_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “ban id” as defined by this API contract.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'latitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'postcode': {'type': ['string', 'null'], 'description': 'Structured value returned for “postcode” as defined by this API contract.'}, 'longitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'code_insee': {'type': ['string', 'null'], 'description': 'Structured value returned for “code insee” as defined by this API contract.'}, 'geocoding_score': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “geocoding score” as defined by this API contract.'}, 'normalized_address': {'type': ['string', 'null'], 'description': 'Structured value returned for “normalized address” as defined by this API contract.'}}, 'description': 'Structured value returned for “location” as defined by this API contract.', 'additionalProperties': False}, 'truncated': {'type': ['boolean', 'null'], 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'total_count': {'type': ['integer', 'null'], 'description': 'Total number of matching records reported by the source or endpoint.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'source_status': {'enum': ['ok'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok).'}, 'returned_count': {'type': ['integer', 'null'], 'description': 'Number of records included in this response.'}}, 'description': 'Structured result returned by the real-estate/fr/dpe API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'address': {'type': 'string', 'maxLength': 250, 'minLength': 5, 'description': 'Optional value for “address” as defined by this API contract. (minimum length 5; maximum length 250).'}, 'radius_m': {'type': 'integer', 'default': 650, 'maximum': 650, 'minimum': 100, 'description': 'Optional value for “radius m” as defined by this API contract. (minimum 100; maximum 650; default 650).'}, 'code_insee': {'type': 'string', 'pattern': '^(?:[0-9]{5}|2[ABab][0-9]{3})$', 'description': 'Optional value for “code insee” as defined by this API contract.'}, 'property_type': {'enum': ['all', 'house', 'apartment'], 'type': 'string', 'default': 'all', 'description': 'Optional value for “property type” as defined by this API contract. (default all; allowed values: all, house, apartment).'}, 'lookback_years': {'type': 'integer', 'default': 5, 'maximum': 5, 'minimum': 1, 'description': 'Optional value for “lookback years” as defined by this API contract. (minimum 1; maximum 5; default 5).'}}, 'description': 'Structured input parameters for the real-estate/fr/market API. At least one of address or code_insee must be provided.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['location', 'coverage_scope', 'radius_m', 'property_type', 'lookback_years', 'source_status', 'source_total_count', 'sampled_count', 'sample_truncated', 'summary', 'yearly', 'generated_at'], 'properties': {'yearly': {'type': 'array', 'items': {'type': 'object', 'required': ['year', 'transactions_count', 'median_price_per_m2'], 'properties': {'year': {'type': 'string', 'description': 'Structured value returned for “year” as defined by this API contract.'}, 'transactions_count': {'type': 'integer', 'description': 'Structured value returned for “transactions count” as defined by this API contract.'}, 'median_price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “median price per m2” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “yearly” as defined by this API contract.'}, 'summary': {'type': 'object', 'required': ['median_price_per_m2', 'p25_price_per_m2', 'p75_price_per_m2', 'median_transaction_amount'], 'properties': {'p25_price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “p25 price per m2” as defined by this API contract.'}, 'p75_price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “p75 price per m2” as defined by this API contract.'}, 'median_price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “median price per m2” as defined by this API contract.'}, 'median_transaction_amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “median transaction amount” as defined by this API contract.'}}, 'description': 'Compact derived summary of the returned records.', 'additionalProperties': False}, 'location': {'type': 'object', 'required': ['code_insee', 'address', 'normalized_address', 'postcode', 'city', 'ban_id', 'geocoding_score', 'longitude', 'latitude'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'ban_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “ban id” as defined by this API contract.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'latitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'postcode': {'type': ['string', 'null'], 'description': 'Structured value returned for “postcode” as defined by this API contract.'}, 'longitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'code_insee': {'type': ['string', 'null'], 'description': 'Structured value returned for “code insee” as defined by this API contract.'}, 'geocoding_score': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “geocoding score” as defined by this API contract.'}, 'normalized_address': {'type': ['string', 'null'], 'description': 'Structured value returned for “normalized address” as defined by this API contract.'}}, 'description': 'Structured value returned for “location” as defined by this API contract.', 'additionalProperties': False}, 'radius_m': {'type': ['integer', 'null'], 'description': 'Structured value returned for “radius m” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'property_type': {'type': 'string', 'description': 'Structured value returned for “property type” as defined by this API contract.'}, 'sampled_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “sampled count” as defined by this API contract.'}, 'source_status': {'enum': ['ok'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok).'}, 'coverage_scope': {'enum': ['radius', 'commune'], 'type': 'string', 'description': 'Structured value returned for “coverage scope” as defined by this API contract. (allowed values: radius, commune).'}, 'lookback_years': {'type': 'integer', 'description': 'Structured value returned for “lookback years” as defined by this API contract.'}, 'sample_truncated': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “sample truncated” as defined by this API contract.'}, 'source_total_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “source total count” as defined by this API contract.'}}, 'description': 'Structured result returned by the real-estate/fr/market API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'anyOf': [{'required': ['address']}, {'required': ['code_insee', 'section', 'numero']}], 'properties': {'numero': {'type': ['string', 'integer'], 'description': 'Optional value for “numero” as defined by this API contract.'}, 'address': {'type': 'string', 'maxLength': 250, 'minLength': 5, 'description': 'Optional value for “address” as defined by this API contract. (minimum length 5; maximum length 250).'}, 'section': {'type': 'string', 'pattern': '^[0-9A-Za-z]{1,2}$', 'description': 'Optional value for “section” as defined by this API contract.'}, 'code_insee': {'type': 'string', 'pattern': '^(?:[0-9]{5}|2[ABab][0-9]{3})$', 'description': 'Optional value for “code insee” as defined by this API contract.'}}, 'description': 'Structured input parameters for the real-estate/fr/parcel API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['location', 'source_status', 'total_count', 'parcels', 'bbox', 'generated_at'], 'properties': {'bbox': {'type': ['array', 'null'], 'items': {'type': 'number'}, 'description': 'Structured value returned for “bbox” as defined by this API contract.'}, 'parcels': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'code_insee', 'section', 'numero', 'commune', 'feuille', 'geometry'], 'properties': {'id': {'type': ['string', 'null'], 'description': 'Structured value returned for “id” as defined by this API contract.'}, 'numero': {'type': ['string', 'null'], 'description': 'Structured value returned for “numero” as defined by this API contract.'}, 'commune': {'type': ['string', 'null'], 'description': 'Structured value returned for “commune” as defined by this API contract.'}, 'feuille': {'type': ['string', 'null'], 'description': 'Structured value returned for “feuille” as defined by this API contract.'}, 'section': {'type': ['string', 'null'], 'description': 'Structured value returned for “section” as defined by this API contract.'}, 'geometry': {'type': ['object', 'null'], 'description': 'Structured value returned for “geometry” as defined by this API contract.'}, 'code_insee': {'type': ['string', 'null'], 'description': 'Structured value returned for “code insee” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “parcels” as defined by this API contract.'}, 'location': {'type': 'object', 'required': ['code_insee', 'address', 'normalized_address', 'postcode', 'city', 'ban_id', 'geocoding_score', 'longitude', 'latitude'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'ban_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “ban id” as defined by this API contract.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'latitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'postcode': {'type': ['string', 'null'], 'description': 'Structured value returned for “postcode” as defined by this API contract.'}, 'longitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'code_insee': {'type': ['string', 'null'], 'description': 'Structured value returned for “code insee” as defined by this API contract.'}, 'geocoding_score': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “geocoding score” as defined by this API contract.'}, 'normalized_address': {'type': ['string', 'null'], 'description': 'Structured value returned for “normalized address” as defined by this API contract.'}}, 'description': 'Structured value returned for “location” as defined by this API contract.', 'additionalProperties': False}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'total_count': {'type': ['integer', 'null'], 'description': 'Total number of matching records reported by the source or endpoint.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'source_status': {'enum': ['ok'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok).'}}, 'description': 'Structured result returned by the real-estate/fr/parcel API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'address': {'type': 'string', 'maxLength': 250, 'minLength': 5, 'description': 'Optional value for “address” as defined by this API contract. (minimum length 5; maximum length 250).'}, 'code_insee': {'type': 'string', 'pattern': '^(?:[0-9]{5}|2[ABab][0-9]{3})$', 'description': 'Optional value for “code insee” as defined by this API contract.'}}, 'description': 'Structured input parameters for the real-estate/fr/risks API. At least one of address or code_insee must be provided.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['location', 'scope', 'source_status', 'risk_count', 'risks', 'generated_at'], 'properties': {'risks': {'type': 'array', 'items': {'type': 'object', 'required': ['code', 'label', 'zone_sismicite'], 'properties': {'code': {'type': ['string', 'null'], 'description': 'Structured value returned for “code” as defined by this API contract.'}, 'label': {'type': ['string', 'null'], 'description': 'Structured value returned for “label” as defined by this API contract.'}, 'zone_sismicite': {'type': ['string', 'null'], 'description': 'Structured value returned for “zone sismicite” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “risks” as defined by this API contract.'}, 'scope': {'enum': ['commune'], 'type': 'string', 'description': 'Structured value returned for “scope” as defined by this API contract. (allowed values: commune).'}, 'location': {'type': 'object', 'required': ['code_insee', 'address', 'normalized_address', 'postcode', 'city', 'ban_id', 'geocoding_score', 'longitude', 'latitude'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'ban_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “ban id” as defined by this API contract.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'latitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'postcode': {'type': ['string', 'null'], 'description': 'Structured value returned for “postcode” as defined by this API contract.'}, 'longitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'code_insee': {'type': ['string', 'null'], 'description': 'Structured value returned for “code insee” as defined by this API contract.'}, 'geocoding_score': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “geocoding score” as defined by this API contract.'}, 'normalized_address': {'type': ['string', 'null'], 'description': 'Structured value returned for “normalized address” as defined by this API contract.'}}, 'description': 'Structured value returned for “location” as defined by this API contract.', 'additionalProperties': False}, 'risk_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “risk count” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'source_status': {'enum': ['ok'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok).'}}, 'description': 'Structured result returned by the real-estate/fr/risks API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 20, 'maximum': 100, 'minimum': 1, 'description': 'Maximum number of records returned by this call. (minimum 1; maximum 100; default 20).'}, 'address': {'type': 'string', 'maxLength': 250, 'minLength': 5, 'description': 'Optional value for “address” as defined by this API contract. (minimum length 5; maximum length 250).'}, 'date_to': {'type': 'string', 'format': 'date', 'description': 'Optional value for “date to” as defined by this API contract.'}, 'radius_m': {'type': 'integer', 'default': 500, 'maximum': 650, 'minimum': 100, 'description': 'Optional value for “radius m” as defined by this API contract. (minimum 100; maximum 650; default 500).'}, 'date_from': {'type': 'string', 'format': 'date', 'description': 'Optional value for “date from” as defined by this API contract.'}, 'code_insee': {'type': 'string', 'pattern': '^(?:[0-9]{5}|2[ABab][0-9]{3})$', 'description': 'Optional value for “code insee” as defined by this API contract.'}, 'max_amount': {'type': 'number', 'minimum': 0, 'description': 'Optional value for “max amount” as defined by this API contract. (minimum 0).'}, 'min_amount': {'type': 'number', 'minimum': 0, 'description': 'Optional value for “min amount” as defined by this API contract. (minimum 0).'}, 'property_type': {'enum': ['all', 'house', 'apartment'], 'type': 'string', 'default': 'all', 'description': 'Optional value for “property type” as defined by this API contract. (default all; allowed values: all, house, apartment).'}}, 'description': 'Structured input parameters for the real-estate/fr/transactions API. At least one of address or code_insee must be provided.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['location', 'coverage_scope', 'radius_m', 'property_type', 'source_status', 'source_total_count', 'returned_count', 'truncated', 'transactions', 'generated_at'], 'properties': {'location': {'type': 'object', 'required': ['code_insee', 'address', 'normalized_address', 'postcode', 'city', 'ban_id', 'geocoding_score', 'longitude', 'latitude'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'ban_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “ban id” as defined by this API contract.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'latitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'postcode': {'type': ['string', 'null'], 'description': 'Structured value returned for “postcode” as defined by this API contract.'}, 'longitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'code_insee': {'type': ['string', 'null'], 'description': 'Structured value returned for “code insee” as defined by this API contract.'}, 'geocoding_score': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “geocoding score” as defined by this API contract.'}, 'normalized_address': {'type': ['string', 'null'], 'description': 'Structured value returned for “normalized address” as defined by this API contract.'}}, 'description': 'Structured value returned for “location” as defined by this API contract.', 'additionalProperties': False}, 'radius_m': {'type': ['integer', 'null'], 'description': 'Structured value returned for “radius m” as defined by this API contract.'}, 'truncated': {'type': ['boolean', 'null'], 'description': 'Whether additional matching records existed beyond the returned result limit.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'transactions': {'type': 'array', 'items': {'type': 'object', 'required': ['transaction_id', 'date', 'nature', 'amount', 'property_type_code', 'property_type', 'built_area_m2', 'land_area_m2', 'price_per_m2', 'commune_codes', 'parcel_ids', 'longitude', 'latitude'], 'properties': {'date': {'type': ['string', 'null'], 'description': 'Structured value returned for “date” as defined by this API contract.'}, 'amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “amount” as defined by this API contract.'}, 'nature': {'type': ['string', 'null'], 'description': 'Structured value returned for “nature” as defined by this API contract.'}, 'latitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'longitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'parcel_ids': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “parcel ids” as defined by this API contract.'}, 'land_area_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “land area m2” as defined by this API contract.'}, 'price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “price per m2” as defined by this API contract.'}, 'built_area_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “built area m2” as defined by this API contract.'}, 'commune_codes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “commune codes” as defined by this API contract.'}, 'property_type': {'type': ['string', 'null'], 'description': 'Structured value returned for “property type” as defined by this API contract.'}, 'transaction_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “transaction id” as defined by this API contract.'}, 'property_type_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “property type code” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “transactions” as defined by this API contract.'}, 'property_type': {'type': 'string', 'description': 'Structured value returned for “property type” as defined by this API contract.'}, 'source_status': {'enum': ['ok'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok).'}, 'coverage_scope': {'enum': ['radius', 'commune'], 'type': 'string', 'description': 'Structured value returned for “coverage scope” as defined by this API contract. (allowed values: radius, commune).'}, 'returned_count': {'type': ['integer', 'null'], 'description': 'Number of records included in this response.'}, 'source_total_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “source total count” as defined by this API contract.'}}, 'description': 'Structured result returned by the real-estate/fr/transactions API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['property_type', 'surface_m2'], 'properties': {'address': {'type': 'string', 'maxLength': 250, 'minLength': 5, 'description': 'Optional value for “address” as defined by this API contract. (minimum length 5; maximum length 250).'}, 'radius_m': {'type': 'integer', 'default': 650, 'maximum': 650, 'minimum': 100, 'description': 'Optional value for “radius m” as defined by this API contract. (minimum 100; maximum 650; default 650).'}, 'code_insee': {'type': 'string', 'pattern': '^(?:[0-9]{5}|2[ABab][0-9]{3})$', 'description': 'Optional value for “code insee” as defined by this API contract.'}, 'surface_m2': {'type': 'number', 'maximum': 1000, 'minimum': 9, 'description': 'Required value for “surface m2” as defined by this API contract. (minimum 9; maximum 1000).'}, 'property_type': {'enum': ['house', 'apartment'], 'type': 'string', 'description': 'Required value for “property type” as defined by this API contract. (allowed values: house, apartment).'}, 'lookback_years': {'type': 'integer', 'default': 3, 'maximum': 5, 'minimum': 1, 'description': 'Optional value for “lookback years” as defined by this API contract. (minimum 1; maximum 5; default 3).'}}, 'description': 'Structured input parameters for the real-estate/fr/valuation API. At least one of address or code_insee must be provided.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['location', 'property_type', 'surface_m2', 'radius_m', 'lookback_years', 'source_status', 'source_total_count', 'source_truncated', 'comparable_count', 'median_price_per_m2', 'p25_price_per_m2', 'p75_price_per_m2', 'estimated_value', 'estimated_range_low', 'estimated_range_high', 'confidence', 'comparables', 'generated_at'], 'properties': {'location': {'type': 'object', 'required': ['code_insee', 'address', 'normalized_address', 'postcode', 'city', 'ban_id', 'geocoding_score', 'longitude', 'latitude'], 'properties': {'city': {'type': ['string', 'null'], 'description': 'Structured value returned for “city” as defined by this API contract.'}, 'ban_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “ban id” as defined by this API contract.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'latitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'postcode': {'type': ['string', 'null'], 'description': 'Structured value returned for “postcode” as defined by this API contract.'}, 'longitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'code_insee': {'type': ['string', 'null'], 'description': 'Structured value returned for “code insee” as defined by this API contract.'}, 'geocoding_score': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “geocoding score” as defined by this API contract.'}, 'normalized_address': {'type': ['string', 'null'], 'description': 'Structured value returned for “normalized address” as defined by this API contract.'}}, 'description': 'Structured value returned for “location” as defined by this API contract.', 'additionalProperties': False}, 'radius_m': {'type': ['integer', 'null'], 'description': 'Structured value returned for “radius m” as defined by this API contract.'}, 'confidence': {'enum': ['high', 'medium', 'low', 'insufficient'], 'type': 'string', 'description': 'Confidence indicator associated with an inferred or derived result. (allowed values: high, medium, low, insufficient).'}, 'surface_m2': {'type': 'number', 'description': 'Structured value returned for “surface m2” as defined by this API contract.'}, 'comparables': {'type': 'array', 'items': {'type': 'object', 'required': ['transaction_id', 'date', 'nature', 'amount', 'property_type_code', 'property_type', 'built_area_m2', 'land_area_m2', 'price_per_m2', 'commune_codes', 'parcel_ids', 'longitude', 'latitude'], 'properties': {'date': {'type': ['string', 'null'], 'description': 'Structured value returned for “date” as defined by this API contract.'}, 'amount': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “amount” as defined by this API contract.'}, 'nature': {'type': ['string', 'null'], 'description': 'Structured value returned for “nature” as defined by this API contract.'}, 'latitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “latitude” as defined by this API contract.'}, 'longitude': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “longitude” as defined by this API contract.'}, 'parcel_ids': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “parcel ids” as defined by this API contract.'}, 'land_area_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “land area m2” as defined by this API contract.'}, 'price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “price per m2” as defined by this API contract.'}, 'built_area_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “built area m2” as defined by this API contract.'}, 'commune_codes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Structured value returned for “commune codes” as defined by this API contract.'}, 'property_type': {'type': ['string', 'null'], 'description': 'Structured value returned for “property type” as defined by this API contract.'}, 'transaction_id': {'type': ['string', 'null'], 'description': 'Structured value returned for “transaction id” as defined by this API contract.'}, 'property_type_code': {'type': ['string', 'null'], 'description': 'Structured value returned for “property type code” as defined by this API contract.'}}, 'additionalProperties': False}, 'description': 'Structured value returned for “comparables” as defined by this API contract.'}, 'limitations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Known interpretation, source-coverage or freshness limitations for this result.'}, 'generated_at': {'type': 'string', 'description': 'UTC timestamp at which this derived result was generated.'}, 'property_type': {'type': 'string', 'description': 'Structured value returned for “property type” as defined by this API contract.'}, 'source_status': {'enum': ['ok'], 'type': 'string', 'description': 'Availability status of the relevant upstream public source. (allowed values: ok).'}, 'lookback_years': {'type': 'integer', 'description': 'Structured value returned for “lookback years” as defined by this API contract.'}, 'estimated_value': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “estimated value” as defined by this API contract.'}, 'comparable_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “comparable count” as defined by this API contract.'}, 'p25_price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “p25 price per m2” as defined by this API contract.'}, 'p75_price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “p75 price per m2” as defined by this API contract.'}, 'source_truncated': {'type': ['boolean', 'null'], 'description': 'Structured value returned for “source truncated” as defined by this API contract.'}, 'source_total_count': {'type': ['integer', 'null'], 'description': 'Structured value returned for “source total count” as defined by this API contract.'}, 'estimated_range_low': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “estimated range low” as defined by this API contract.'}, 'median_price_per_m2': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “median price per m2” as defined by this API contract.'}, 'estimated_range_high': {'type': ['number', 'integer', 'null'], 'description': 'Structured value returned for “estimated range high” as defined by this API contract.'}}, 'description': 'Structured result returned by the real-estate/fr/valuation API.', 'additionalProperties': False}
Esquema de entrada
{'type': 'object', 'required': ['query'], 'properties': {'query': {'type': 'string', 'description': 'Describe the desired outcome or agent task in natural language; matching uses endpoint names, descriptions, tags, usage guidance and example queries.'}, 'country': {'type': 'string', 'description': 'Optional ISO 3166-1 alpha-2 country code, for example FR; matching is case-insensitive and restricts results to APIs declaring that coverage.'}, 'category': {'type': 'string', 'description': 'Optional exact published category slug; when supplied, only APIs in that category are considered.'}, 'max_price': {'type': 'number', 'minimum': 0, 'description': 'Optional inclusive maximum advertised unit price per call; APIs priced above this value are excluded.'}}, 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['count', 'apis'], 'properties': {'apis': {'type': 'array', 'items': {'type': 'object'}, 'description': 'Matching API descriptors including endpoint, pricing, coverage, usage guidance and documentation links.'}, 'count': {'type': 'integer', 'description': 'Number of published APIs matching the supplied discovery criteria.'}}}
Esquema de entrada
{'type': 'object', 'anyOf': [{'required': ['vat_number']}, {'required': ['country_code', 'number']}], 'properties': {'number': {'type': 'string', 'pattern': '^[A-Za-z0-9]{2,14}$', 'description': 'National VAT identifier body without the country prefix, used together with country_code.'}, 'vat_number': {'type': 'string', 'pattern': '^(?:AT|BE|BG|CY|CZ|DE|DK|EE|EL|ES|FI|FR|GR|HR|HU|IE|IT|LT|LU|LV|MT|NL|PL|PT|RO|SE|SI|SK|XI)[A-Za-z0-9]{2,14}$', 'description': 'Complete EU VAT number including the two-letter country prefix; alternatively provide country_code and number separately.'}, 'country_code': {'enum': ['AT', 'BE', 'BG', 'CY', 'CZ', 'DE', 'DK', 'EE', 'EL', 'ES', 'FI', 'FR', 'GR', 'HR', 'HU', 'IE', 'IT', 'LT', 'LU', 'LV', 'MT', 'NL', 'PL', 'PT', 'RO', 'SE', 'SI', 'SK', 'XI'], 'type': 'string', 'description': 'EU/VIES country prefix used when the VAT number is supplied in separate parts.'}}, 'description': 'Structured input parameters for the vat/eu/validate API.', 'additionalProperties': False}
Esquema de salida
{'type': 'object', 'required': ['vat_number', 'country_code', 'number', 'status', 'valid', 'request_date', 'name', 'address', 'request_identifier', 'checked_at', 'source'], 'properties': {'name': {'type': ['string', 'null'], 'description': 'Publicly available company, person, buyer or record name for this result.'}, 'valid': {'type': ['boolean', 'null'], 'description': 'Whether the supplied identifier passed the endpoint’s validation rules.'}, 'number': {'type': 'string', 'description': 'Structured value returned for “number” as defined by this API contract.'}, 'source': {'type': 'string', 'description': 'Structured value returned for “source” as defined by this API contract.'}, 'status': {'type': 'string', 'description': 'Normalized endpoint or source status.'}, 'address': {'type': ['string', 'null'], 'description': 'Structured value returned for “address” as defined by this API contract.'}, 'checked_at': {'type': 'string', 'description': 'UTC timestamp at which HelpMyAgent performed the check.'}, 'vat_number': {'type': 'string', 'description': 'Structured value returned for “vat number” as defined by this API contract.'}, 'country_code': {'type': 'string', 'description': 'Structured value returned for “country code” as defined by this API contract.'}, 'request_date': {'type': ['string', 'null'], 'description': 'Structured value returned for “request date” as defined by this API contract.'}, 'request_identifier': {'type': ['string', 'null'], 'description': 'Structured value returned for “request identifier” as defined by this API contract.'}}, 'description': 'Structured result returned by the vat/eu/validate API.', 'additionalProperties': False}
Cambios recientes en herramientas
Servidores MCP similares
FalaZuki Finance BR
Provides Brazil-focused financial calculations and rules for investments, credit, taxes, payroll, labor costs, debt, budgeting, a…
XBOSS
Accesses Korean tax, social insurance, payroll, cash receipt, e-tax invoice, and certificate filing services.
Sirenic
Provides European company registry, financial, procurement, sanctions, regulatory, insolvency, ownership, and ongoing due-diligen…
Xearno Tools
Provides financial, tax, employment-benefit, lending, pricing, and business calculators using jurisdiction-specific rules and cur…
schedule-iii
Transforms Indian company trial balances into controlled Schedule III financial statement workbooks with account mappings, disclo…
Cobalt
Searches U.S. business registrations, verifies business tax identifiers, and retrieves UCC lien filings for company due diligence…
Imperio — Italian Tax & Compliance Tools
Provides deterministic Italian tax, invoicing, identity, payment-detail validation, anti-fraud, INTRASTAT, NIS2, and compliance c…
AdvBox
Manages legal practice customers, lawsuits, movements, publications, notes, settings, and related financial transactions.