EU Tenders

API reference

Every tool the MCP server at https://eu-data-mcp.msabaliauskas-c33.workers.dev/mcp exposes, read live from the server so this page cannot drift from the code.

Account

eu_status

Where this tenant's data lives, its plan, and today's usage.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {},
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'jurisdiction': {'type': 'string'},
                'limit': {'type': 'number'},
                'overageToday': {'description': 'Calls above the included '
                                                'daily calls, billed as '
                                                'overage',
                                 'type': 'number'},
                'plan': {'type': 'string'},
                'usedToday': {'type': 'number'},
                'watches': {'type': 'number'}},
 'required': ['jurisdiction',
              'plan',
              'usedToday',
              'limit',
              'watches',
              'overageToday'],
 'type': 'object'}

eu_plan

This tenant's plan, its limits, and where to upgrade.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {},
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'callsPerDay': {'type': 'number'},
                'dashboardUrl': {'type': 'string'},
                'plan': {'type': 'string'},
                'watches': {'type': 'number'}},
 'required': ['plan', 'callsPerDay', 'watches', 'dashboardUrl'],
 'type': 'object'}

Public tenders

tenders_search

Search EU public tender notices (TED) by country, CPV code, text in title or buyer, and date.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'filter': {'properties': {'contractType': {'description': 'Main '
                                                                          'contract '
                                                                          'type',
                                                           'enum': ['works',
                                                                    'supplies',
                                                                    'services'],
                                                           'type': 'string'},
                                          'countries': {'description': 'ISO '
                                                                       'alpha-3 '
                                                                       'codes, '
                                                                       'e.g. '
                                                                       'LTU, '
                                                                       'SWE',
                                                        'items': {'pattern': '^[A-Z]{3}$',
                                                                  'type': 'string'},
                                                        'maxItems': 27,
                                                        'type': 'array'},
                                          'cpv': {'description': 'CPV codes, '
                                                                 'trailing * '
                                                                 'for prefix',
                                                  'items': {'pattern': '^\\d{2,8}\\*?$',
                                                            'type': 'string'},
                                                  'maxItems': 20,
                                                  'type': 'array'},
                                          'publishedAfter': {'description': 'YYYYMMDD, '
                                                                            'default: '
                                                                            '7 '
                                                                            'days '
                                                                            'ago',
                                                             'pattern': '^\\d{8}$',
                                                             'type': 'string'},
                                          'text': {'maxLength': 200,
                                                   'type': 'string'}},
                           'type': 'object'},
                'limit': {'default': 10,
                          'maximum': 50,
                          'minimum': 1,
                          'type': 'integer'},
                'page': {'default': 1,
                         'maximum': 9007199254740991,
                         'minimum': 1,
                         'type': 'integer'}},
 'required': ['filter'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'notices': {'items': {'additionalProperties': False,
                                      'properties': {'buyer': {'type': 'string'},
                                                     'contractType': {'description': 'works, '
                                                                                     'supplies '
                                                                                     'or '
                                                                                     'services',
                                                                      'type': ['string',
                                                                               'null']},
                                                     'countries': {'items': {'type': 'string'},
                                                                   'type': 'array'},
                                                     'cpv': {'items': {'type': 'string'},
                                                             'type': 'array'},
                                                     'deadline': {'type': ['string',
                                                                           'null']},
                                                     'deadlineTime': {'description': 'Time '
                                                                                     'of '
                                                                                     'the '
                                                                                     'deadline '
                                                                                     'with '
                                                                                     'its '
                                                                                     'UTC '
                                                                                     'offset, '
                                                                                     'e.g. '
                                                                                     '10:00:00+01:00',
                                                                      'type': ['string',
                                                                               'null']},
                                                     'documentsUrl': {'description': 'Procurement '
                                                                                     'documents, '
                                                                                     'as '
                                                                                     'the '
                                                                                     'buyer '
                                                                                     'published '
                                                                                     'them '
                                                                                     'on '
                                                                                     'TED',
                                                                      'type': ['string',
                                                                               'null']},
                                                     'noticeType': {'type': 'string'},
                                                     'pdf': {'type': ['string',
                                                                      'null']},
                                                     'placeCity': {'type': ['string',
                                                                            'null']},
                                                     'placeRegions': {'description': 'NUTS '
                                                                                     'region '
                                                                                     'codes '
                                                                                     'of '
                                                                                     'the '
                                                                                     'place '
                                                                                     'of '
                                                                                     'performance',
                                                                      'items': {'type': 'string'},
                                                                      'type': 'array'},
                                                     'publicationDate': {'type': 'string'},
                                                     'publicationNumber': {'type': 'string'},
                                                     'submissionUrl': {'description': 'Where '
                                                                                      'bids '
                                                                                      'are '
                                                                                      'submitted, '
                                                                                      'as '
                                                                                      'the '
                                                                                      'buyer '
                                                                                      'published '
                                                                                      'it '
                                                                                      'on '
                                                                                      'TED',
                                                                       'type': ['string',
                                                                                'null']},
                                                     'title': {'type': 'string'},
                                                     'xml': {'type': ['string',
                                                                      'null']}},
                                      'required': ['publicationNumber',
                                                   'title',
                                                   'buyer',
                                                   'countries',
                                                   'cpv',
                                                   'deadline',
                                                   'publicationDate',
                                                   'noticeType',
                                                   'pdf',
                                                   'xml'],
                                      'type': 'object'},
                            'type': 'array'},
                'source': {'description': 'copy: our EU database; live: TED '
                                          'directly, used when the copy is '
                                          'unreachable',
                           'enum': ['copy', 'live'],
                           'type': 'string'},
                'total': {'type': 'number'}},
 'required': ['total', 'notices', 'source'],
 'type': 'object'}

tenders_get

One tender notice by its TED publication number, e.g. 722772-2026.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'publicationNumber': {'pattern': '^\\d+-\\d{4}$',
                                      'type': 'string'}},
 'required': ['publicationNumber'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'notice': {'anyOf': [{'additionalProperties': False,
                                      'properties': {'awardedValue': {'anyOf': [{'additionalProperties': False,
                                                                                 'properties': {'amount': {'type': 'number'},
                                                                                                'currency': {'type': 'string'}},
                                                                                 'required': ['amount',
                                                                                              'currency'],
                                                                                 'type': 'object'},
                                                                                {'type': 'null'}]},
                                                     'buyer': {'type': 'string'},
                                                     'buyerCity': {'type': ['string',
                                                                            'null']},
                                                     'contractType': {'description': 'works, '
                                                                                     'supplies '
                                                                                     'or '
                                                                                     'services',
                                                                      'type': ['string',
                                                                               'null']},
                                                     'countries': {'items': {'type': 'string'},
                                                                   'type': 'array'},
                                                     'cpv': {'items': {'type': 'string'},
                                                             'type': 'array'},
                                                     'deadline': {'type': ['string',
                                                                           'null']},
                                                     'deadlineTime': {'description': 'Time '
                                                                                     'of '
                                                                                     'the '
                                                                                     'deadline '
                                                                                     'with '
                                                                                     'its '
                                                                                     'UTC '
                                                                                     'offset, '
                                                                                     'e.g. '
                                                                                     '10:00:00+01:00',
                                                                      'type': ['string',
                                                                               'null']},
                                                     'description': {'description': 'In '
                                                                                    'the '
                                                                                    "notice's "
                                                                                    'own '
                                                                                    'language',
                                                                     'type': ['string',
                                                                              'null']},
                                                     'documentsUrl': {'description': 'Procurement '
                                                                                     'documents, '
                                                                                     'as '
                                                                                     'the '
                                                                                     'buyer '
                                                                                     'published '
                                                                                     'them '
                                                                                     'on '
                                                                                     'TED',
                                                                      'type': ['string',
                                                                               'null']},
                                                     'duration': {'anyOf': [{'additionalProperties': False,
                                                                             'properties': {'unit': {'type': 'string'},
                                                                                            'value': {'type': 'number'}},
                                                                             'required': ['value',
                                                                                          'unit'],
                                                                             'type': 'object'},
                                                                            {'type': 'null'}]},
                                                     'estimatedValue': {'anyOf': [{'additionalProperties': False,
                                                                                   'properties': {'amount': {'type': 'number'},
                                                                                                  'currency': {'type': 'string'}},
                                                                                   'required': ['amount',
                                                                                                'currency'],
                                                                                   'type': 'object'},
                                                                                  {'type': 'null'}]},
                                                     'lots': {'description': 'Lot '
                                                                             'titles',
                                                              'items': {'type': 'string'},
                                                              'type': 'array'},
                                                     'noticeType': {'type': 'string'},
                                                     'pdf': {'type': ['string',
                                                                      'null']},
                                                     'placeCity': {'type': ['string',
                                                                            'null']},
                                                     'placeRegions': {'description': 'NUTS '
                                                                                     'region '
                                                                                     'codes '
                                                                                     'of '
                                                                                     'the '
                                                                                     'place '
                                                                                     'of '
                                                                                     'performance',
                                                                      'items': {'type': 'string'},
                                                                      'type': 'array'},
                                                     'procedureType': {'type': ['string',
                                                                                'null']},
                                                     'publicationDate': {'type': 'string'},
                                                     'publicationNumber': {'type': 'string'},
                                                     'submissionUrl': {'description': 'Where '
                                                                                      'bids '
                                                                                      'are '
                                                                                      'submitted, '
                                                                                      'as '
                                                                                      'the '
                                                                                      'buyer '
                                                                                      'published '
                                                                                      'it '
                                                                                      'on '
                                                                                      'TED',
                                                                       'type': ['string',
                                                                                'null']},
                                                     'tendersReceived': {'type': ['number',
                                                                                  'null']},
                                                     'title': {'type': 'string'},
                                                     'xml': {'type': ['string',
                                                                      'null']}},
                                      'required': ['publicationNumber',
                                                   'title',
                                                   'buyer',
                                                   'countries',
                                                   'cpv',
                                                   'deadline',
                                                   'publicationDate',
                                                   'noticeType',
                                                   'pdf',
                                                   'xml'],
                                      'type': 'object'},
                                     {'type': 'null'}]},
                'source': {'description': 'copy: our EU database; live: TED '
                                          'directly, used when the copy is '
                                          'unreachable',
                           'enum': ['copy', 'live'],
                           'type': 'string'}},
 'required': ['notice', 'source'],
 'type': 'object'}

tenders_watch

Create a tenders watchlist that polls for new items matching a filter. Returns the watch id.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'filter': {'properties': {'contractType': {'description': 'Main '
                                                                          'contract '
                                                                          'type',
                                                           'enum': ['works',
                                                                    'supplies',
                                                                    'services'],
                                                           'type': 'string'},
                                          'countries': {'description': 'ISO '
                                                                       'alpha-3 '
                                                                       'codes, '
                                                                       'e.g. '
                                                                       'LTU, '
                                                                       'SWE',
                                                        'items': {'pattern': '^[A-Z]{3}$',
                                                                  'type': 'string'},
                                                        'maxItems': 27,
                                                        'type': 'array'},
                                          'cpv': {'description': 'CPV codes, '
                                                                 'trailing * '
                                                                 'for prefix',
                                                  'items': {'pattern': '^\\d{2,8}\\*?$',
                                                            'type': 'string'},
                                                  'maxItems': 20,
                                                  'type': 'array'},
                                          'publishedAfter': {'description': 'YYYYMMDD, '
                                                                            'default: '
                                                                            '7 '
                                                                            'days '
                                                                            'ago',
                                                             'pattern': '^\\d{8}$',
                                                             'type': 'string'},
                                          'text': {'maxLength': 200,
                                                   'type': 'string'}},
                           'type': 'object'},
                'intervalMin': {'default': 60,
                                'maximum': 1440,
                                'minimum': 15,
                                'type': 'integer'},
                'name': {'maxLength': 80, 'minLength': 1, 'type': 'string'}},
 'required': ['name', 'filter'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'watchId': {'type': 'string'}},
 'required': ['watchId'],
 'type': 'object'}

tenders_watch_list

List this tenant's tenders watchlists.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {},
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'watches': {'items': {'additionalProperties': False,
                                      'properties': {'created_at': {'type': 'string'},
                                                     'id': {'type': 'string'},
                                                     'name': {'type': 'string'}},
                                      'required': ['id', 'name', 'created_at'],
                                      'type': 'object'},
                            'type': 'array'}},
 'required': ['watches'],
 'type': 'object'}

tenders_watch_matches

Items a tenders watchlist has found. Call tenders_watch_ack afterwards to mark them seen.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'limit': {'default': 50,
                          'maximum': 200,
                          'minimum': 1,
                          'type': 'integer'},
                'since': {'type': 'string'},
                'undeliveredOnly': {'default': False, 'type': 'boolean'},
                'watchId': {'type': 'string'}},
 'required': ['watchId'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'active': {'type': 'boolean'},
                'cursor': {'type': 'string'},
                'items': {'items': {'additionalProperties': False,
                                    'properties': {'buyer': {'type': 'string'},
                                                   'contractType': {'description': 'works, '
                                                                                   'supplies '
                                                                                   'or '
                                                                                   'services',
                                                                    'type': ['string',
                                                                             'null']},
                                                   'countries': {'items': {'type': 'string'},
                                                                 'type': 'array'},
                                                   'cpv': {'items': {'type': 'string'},
                                                           'type': 'array'},
                                                   'deadline': {'type': ['string',
                                                                         'null']},
                                                   'deadlineTime': {'description': 'Time '
                                                                                   'of '
                                                                                   'the '
                                                                                   'deadline '
                                                                                   'with '
                                                                                   'its '
                                                                                   'UTC '
                                                                                   'offset, '
                                                                                   'e.g. '
                                                                                   '10:00:00+01:00',
                                                                    'type': ['string',
                                                                             'null']},
                                                   'documentsUrl': {'description': 'Procurement '
                                                                                   'documents, '
                                                                                   'as '
                                                                                   'the '
                                                                                   'buyer '
                                                                                   'published '
                                                                                   'them '
                                                                                   'on '
                                                                                   'TED',
                                                                    'type': ['string',
                                                                             'null']},
                                                   'noticeType': {'type': 'string'},
                                                   'pdf': {'type': ['string',
                                                                    'null']},
                                                   'placeCity': {'type': ['string',
                                                                          'null']},
                                                   'placeRegions': {'description': 'NUTS '
                                                                                   'region '
                                                                                   'codes '
                                                                                   'of '
                                                                                   'the '
                                                                                   'place '
                                                                                   'of '
                                                                                   'performance',
                                                                    'items': {'type': 'string'},
                                                                    'type': 'array'},
                                                   'publicationDate': {'type': 'string'},
                                                   'publicationNumber': {'type': 'string'},
                                                   'submissionUrl': {'description': 'Where '
                                                                                    'bids '
                                                                                    'are '
                                                                                    'submitted, '
                                                                                    'as '
                                                                                    'the '
                                                                                    'buyer '
                                                                                    'published '
                                                                                    'it '
                                                                                    'on '
                                                                                    'TED',
                                                                     'type': ['string',
                                                                              'null']},
                                                   'title': {'type': 'string'},
                                                   'xml': {'type': ['string',
                                                                    'null']}},
                                    'required': ['publicationNumber',
                                                 'title',
                                                 'buyer',
                                                 'countries',
                                                 'cpv',
                                                 'deadline',
                                                 'publicationDate',
                                                 'noticeType',
                                                 'pdf',
                                                 'xml'],
                                    'type': 'object'},
                          'type': 'array'}},
 'required': ['cursor', 'active', 'items'],
 'type': 'object'}

tenders_watch_ack

Mark items from a tenders watchlist as delivered, by publicationNumber.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'ids': {'items': {'type': 'string'},
                        'maxItems': 200,
                        'type': 'array'},
                'watchId': {'type': 'string'}},
 'required': ['watchId', 'ids'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'acked': {'type': 'number'}},
 'required': ['acked'],
 'type': 'object'}

tenders_watch_stop

Stop a tenders watchlist. Its matches stay readable.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'watchId': {'type': 'string'}},
 'required': ['watchId'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'stopped': {'type': 'boolean'}},
 'required': ['stopped'],
 'type': 'object'}

Company filings

filings_search

Search ESEF annual report filings of EU-listed companies by country, LEI, or period end.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'filter': {'properties': {'countries': {'description': 'ISO '
                                                                       'alpha-2 '
                                                                       'codes, '
                                                                       'e.g. '
                                                                       'LT, SE',
                                                        'items': {'maxLength': 2,
                                                                  'minLength': 2,
                                                                  'type': 'string'},
                                                        'maxItems': 30,
                                                        'type': 'array'},
                                          'leis': {'description': 'Legal '
                                                                  'Entity '
                                                                  'Identifiers',
                                                   'items': {'maxLength': 20,
                                                             'minLength': 20,
                                                             'type': 'string'},
                                                   'maxItems': 20,
                                                   'type': 'array'},
                                          'periodEnd': {'pattern': '^\\d{4}-\\d{2}-\\d{2}$',
                                                        'type': 'string'}},
                           'type': 'object'},
                'page': {'default': 1,
                         'maximum': 9007199254740991,
                         'minimum': 1,
                         'type': 'integer'},
                'size': {'default': 20,
                         'maximum': 100,
                         'minimum': 1,
                         'type': 'integer'}},
 'required': ['filter'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'filings': {'items': {'additionalProperties': False,
                                      'properties': {'country': {'type': 'string'},
                                                     'dateAdded': {'type': 'string'},
                                                     'entityName': {'type': 'string'},
                                                     'errors': {'type': 'number'},
                                                     'fxoId': {'type': 'string'},
                                                     'id': {'type': 'string'},
                                                     'jsonPath': {'type': ['string',
                                                                           'null']},
                                                     'lei': {'type': 'string'},
                                                     'periodEnd': {'type': 'string'},
                                                     'reportUrl': {'type': ['string',
                                                                            'null']},
                                                     'viewerUrl': {'type': ['string',
                                                                            'null']},
                                                     'warnings': {'type': 'number'}},
                                      'required': ['id',
                                                   'fxoId',
                                                   'lei',
                                                   'entityName',
                                                   'country',
                                                   'periodEnd',
                                                   'dateAdded',
                                                   'errors',
                                                   'warnings',
                                                   'reportUrl',
                                                   'viewerUrl',
                                                   'jsonPath'],
                                      'type': 'object'},
                            'type': 'array'},
                'total': {'type': 'number'}},
 'required': ['total', 'filings'],
 'type': 'object'}

filings_get

One filing by its id from filings_search.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'id': {'pattern': '^\\d+$', 'type': 'string'}},
 'required': ['id'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'filing': {'anyOf': [{'additionalProperties': False,
                                      'properties': {'country': {'type': 'string'},
                                                     'dateAdded': {'type': 'string'},
                                                     'entityName': {'type': 'string'},
                                                     'errors': {'type': 'number'},
                                                     'fxoId': {'type': 'string'},
                                                     'id': {'type': 'string'},
                                                     'jsonPath': {'type': ['string',
                                                                           'null']},
                                                     'lei': {'type': 'string'},
                                                     'periodEnd': {'type': 'string'},
                                                     'reportUrl': {'type': ['string',
                                                                            'null']},
                                                     'viewerUrl': {'type': ['string',
                                                                            'null']},
                                                     'warnings': {'type': 'number'}},
                                      'required': ['id',
                                                   'fxoId',
                                                   'lei',
                                                   'entityName',
                                                   'country',
                                                   'periodEnd',
                                                   'dateAdded',
                                                   'errors',
                                                   'warnings',
                                                   'reportUrl',
                                                   'viewerUrl',
                                                   'jsonPath'],
                                      'type': 'object'},
                                     {'type': 'null'}]}},
 'required': ['filing'],
 'type': 'object'}

filings_facts

Values of IFRS concepts from a filing, e.g. ifrs-full:Revenue, ifrs-full:ProfitLoss, ifrs-full:Assets.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'concepts': {'items': {'maxLength': 120, 'type': 'string'},
                             'maxItems': 50,
                             'minItems': 1,
                             'type': 'array'},
                'id': {'pattern': '^\\d+$', 'type': 'string'}},
 'required': ['id', 'concepts'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'facts': {'items': {'additionalProperties': False,
                                    'properties': {'concept': {'type': 'string'},
                                                   'decimals': {'type': ['number',
                                                                         'null']},
                                                   'period': {'type': 'string'},
                                                   'unit': {'type': ['string',
                                                                     'null']},
                                                   'value': {'type': ['string',
                                                                      'null']}},
                                    'required': ['concept',
                                                 'value',
                                                 'period',
                                                 'unit',
                                                 'decimals'],
                                    'type': 'object'},
                          'type': 'array'},
                'filing': {'anyOf': [{'additionalProperties': False,
                                      'properties': {'country': {'type': 'string'},
                                                     'dateAdded': {'type': 'string'},
                                                     'entityName': {'type': 'string'},
                                                     'errors': {'type': 'number'},
                                                     'fxoId': {'type': 'string'},
                                                     'id': {'type': 'string'},
                                                     'jsonPath': {'type': ['string',
                                                                           'null']},
                                                     'lei': {'type': 'string'},
                                                     'periodEnd': {'type': 'string'},
                                                     'reportUrl': {'type': ['string',
                                                                            'null']},
                                                     'viewerUrl': {'type': ['string',
                                                                            'null']},
                                                     'warnings': {'type': 'number'}},
                                      'required': ['id',
                                                   'fxoId',
                                                   'lei',
                                                   'entityName',
                                                   'country',
                                                   'periodEnd',
                                                   'dateAdded',
                                                   'errors',
                                                   'warnings',
                                                   'reportUrl',
                                                   'viewerUrl',
                                                   'jsonPath'],
                                      'type': 'object'},
                                     {'type': 'null'}]}},
 'required': ['filing', 'facts'],
 'type': 'object'}

filings_watch

Create a filings watchlist that polls for new items matching a filter. Returns the watch id.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'filter': {'properties': {'countries': {'description': 'ISO '
                                                                       'alpha-2 '
                                                                       'codes, '
                                                                       'e.g. '
                                                                       'LT, SE',
                                                        'items': {'maxLength': 2,
                                                                  'minLength': 2,
                                                                  'type': 'string'},
                                                        'maxItems': 30,
                                                        'type': 'array'},
                                          'leis': {'description': 'Legal '
                                                                  'Entity '
                                                                  'Identifiers',
                                                   'items': {'maxLength': 20,
                                                             'minLength': 20,
                                                             'type': 'string'},
                                                   'maxItems': 20,
                                                   'type': 'array'},
                                          'periodEnd': {'pattern': '^\\d{4}-\\d{2}-\\d{2}$',
                                                        'type': 'string'}},
                           'type': 'object'},
                'intervalMin': {'default': 1440,
                                'maximum': 1440,
                                'minimum': 60,
                                'type': 'integer'},
                'name': {'maxLength': 80, 'minLength': 1, 'type': 'string'}},
 'required': ['name', 'filter'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'watchId': {'type': 'string'}},
 'required': ['watchId'],
 'type': 'object'}

filings_watch_list

List this tenant's filings watchlists.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {},
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'watches': {'items': {'additionalProperties': False,
                                      'properties': {'created_at': {'type': 'string'},
                                                     'id': {'type': 'string'},
                                                     'name': {'type': 'string'}},
                                      'required': ['id', 'name', 'created_at'],
                                      'type': 'object'},
                            'type': 'array'}},
 'required': ['watches'],
 'type': 'object'}

filings_watch_matches

Items a filings watchlist has found. Call filings_watch_ack afterwards to mark them seen.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'limit': {'default': 50,
                          'maximum': 200,
                          'minimum': 1,
                          'type': 'integer'},
                'since': {'type': 'string'},
                'undeliveredOnly': {'default': False, 'type': 'boolean'},
                'watchId': {'type': 'string'}},
 'required': ['watchId'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'active': {'type': 'boolean'},
                'cursor': {'type': 'string'},
                'items': {'items': {'additionalProperties': False,
                                    'properties': {'country': {'type': 'string'},
                                                   'dateAdded': {'type': 'string'},
                                                   'entityName': {'type': 'string'},
                                                   'errors': {'type': 'number'},
                                                   'fxoId': {'type': 'string'},
                                                   'id': {'type': 'string'},
                                                   'jsonPath': {'type': ['string',
                                                                         'null']},
                                                   'lei': {'type': 'string'},
                                                   'periodEnd': {'type': 'string'},
                                                   'reportUrl': {'type': ['string',
                                                                          'null']},
                                                   'viewerUrl': {'type': ['string',
                                                                          'null']},
                                                   'warnings': {'type': 'number'}},
                                    'required': ['id',
                                                 'fxoId',
                                                 'lei',
                                                 'entityName',
                                                 'country',
                                                 'periodEnd',
                                                 'dateAdded',
                                                 'errors',
                                                 'warnings',
                                                 'reportUrl',
                                                 'viewerUrl',
                                                 'jsonPath'],
                                    'type': 'object'},
                          'type': 'array'}},
 'required': ['cursor', 'active', 'items'],
 'type': 'object'}

filings_watch_ack

Mark items from a filings watchlist as delivered, by id.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'ids': {'items': {'type': 'string'},
                        'maxItems': 200,
                        'type': 'array'},
                'watchId': {'type': 'string'}},
 'required': ['watchId', 'ids'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'acked': {'type': 'number'}},
 'required': ['acked'],
 'type': 'object'}

filings_watch_stop

Stop a filings watchlist. Its matches stay readable.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'watchId': {'type': 'string'}},
 'required': ['watchId'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'stopped': {'type': 'boolean'}},
 'required': ['stopped'],
 'type': 'object'}

Old map sheets

maps_find

Historic map sheets that cover a point, optionally for one year. Bounds are west, south, east, north.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'lat': {'maximum': 90, 'minimum': -90, 'type': 'number'},
                'lon': {'maximum': 180, 'minimum': -180, 'type': 'number'},
                'year': {'maximum': 9007199254740991,
                         'minimum': -9007199254740991,
                         'type': 'integer'}},
 'required': ['lat', 'lon'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'sheets': {'items': {'additionalProperties': False,
                                     'properties': {'bounds': {'items': False,
                                                               'maxItems': 4,
                                                               'minItems': 4,
                                                               'prefixItems': [{'type': 'number'},
                                                                               {'type': 'number'},
                                                                               {'type': 'number'},
                                                                               {'type': 'number'}],
                                                               'type': 'array'},
                                                    'id': {'type': 'string'},
                                                    'licence': {'type': 'string'},
                                                    'max_zoom': {'type': 'number'},
                                                    'min_zoom': {'type': 'number'},
                                                    'series': {'type': 'string'},
                                                    'source': {'type': 'string'},
                                                    'title': {'type': 'string'},
                                                    'year': {'type': 'number'}},
                                     'required': ['id',
                                                  'title',
                                                  'year',
                                                  'series',
                                                  'licence',
                                                  'source',
                                                  'bounds',
                                                  'min_zoom',
                                                  'max_zoom'],
                                     'type': 'object'},
                           'type': 'array'}},
 'required': ['sheets'],
 'type': 'object'}

maps_sheet

One map sheet's metadata and licence.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'id': {'pattern': '^[a-z0-9-]+$', 'type': 'string'}},
 'required': ['id'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'sheet': {'anyOf': [{'additionalProperties': False,
                                     'properties': {'bounds': {'items': False,
                                                               'maxItems': 4,
                                                               'minItems': 4,
                                                               'prefixItems': [{'type': 'number'},
                                                                               {'type': 'number'},
                                                                               {'type': 'number'},
                                                                               {'type': 'number'}],
                                                               'type': 'array'},
                                                    'id': {'type': 'string'},
                                                    'licence': {'type': 'string'},
                                                    'max_zoom': {'type': 'number'},
                                                    'min_zoom': {'type': 'number'},
                                                    'series': {'type': 'string'},
                                                    'source': {'type': 'string'},
                                                    'title': {'type': 'string'},
                                                    'year': {'type': 'number'}},
                                     'required': ['id',
                                                  'title',
                                                  'year',
                                                  'series',
                                                  'licence',
                                                  'source',
                                                  'bounds',
                                                  'min_zoom',
                                                  'max_zoom'],
                                     'type': 'object'},
                                    {'type': 'null'}]}},
 'required': ['sheet'],
 'type': 'object'}

maps_tile_url

A signed URL, valid 15 minutes, for one XYZ tile of a sheet.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'id': {'pattern': '^[a-z0-9-]+$', 'type': 'string'},
                'x': {'maximum': 9007199254740991,
                      'minimum': 0,
                      'type': 'integer'},
                'y': {'maximum': 9007199254740991,
                      'minimum': 0,
                      'type': 'integer'},
                'z': {'maximum': 20, 'minimum': 0, 'type': 'integer'}},
 'required': ['id', 'z', 'x', 'y'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'expiresInSeconds': {'type': 'number'},
                'url': {'type': 'string'}},
 'required': ['url', 'expiresInSeconds'],
 'type': 'object'}

Contract awards

awards_search

Search EU contract award notices by winner country, CPV code, winner name, or the winner's LEI. Winners are linked to an LEI only by exact national company code.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'filter': {'properties': {'countries': {'description': 'Winner '
                                                                       'countries, '
                                                                       'ISO '
                                                                       'alpha-3',
                                                        'items': {'maxLength': 3,
                                                                  'minLength': 3,
                                                                  'type': 'string'},
                                                        'maxItems': 30,
                                                        'type': 'array'},
                                          'cpv': {'items': {'pattern': '^\\d{2,8}\\*?$',
                                                            'type': 'string'},
                                                  'maxItems': 20,
                                                  'type': 'array'},
                                          'lei': {'description': 'Legal Entity '
                                                                 'Identifier, '
                                                                 '20 '
                                                                 'characters',
                                                  'pattern': '^[A-Z0-9]{20}$',
                                                  'type': 'string'},
                                          'publishedAfter': {'description': 'YYYYMMDD, '
                                                                            'default: '
                                                                            'one '
                                                                            'year '
                                                                            'ago',
                                                             'pattern': '^\\d{8}$',
                                                             'type': 'string'},
                                          'winner': {'description': 'Part of '
                                                                    'the '
                                                                    "winner's "
                                                                    'name',
                                                     'maxLength': 120,
                                                     'minLength': 2,
                                                     'type': 'string'}},
                           'type': 'object'},
                'limit': {'default': 10,
                          'maximum': 50,
                          'minimum': 1,
                          'type': 'integer'},
                'page': {'default': 1,
                         'maximum': 9007199254740991,
                         'minimum': 1,
                         'type': 'integer'}},
 'required': ['filter'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'awards': {'items': {'additionalProperties': False,
                                     'properties': {'buyer': {'type': 'string'},
                                                    'buyerCountry': {'type': 'string'},
                                                    'currency': {'type': ['string',
                                                                          'null']},
                                                    'lei': {'type': ['string',
                                                                     'null']},
                                                    'noticeValue': {'description': 'Value '
                                                                                   'of '
                                                                                   'the '
                                                                                   'whole '
                                                                                   'award '
                                                                                   'notice, '
                                                                                   'shared '
                                                                                   'by '
                                                                                   'all '
                                                                                   'its '
                                                                                   'winners',
                                                                    'type': ['string',
                                                                             'null']},
                                                    'publicationDate': {'type': 'string'},
                                                    'publicationNumber': {'type': 'string'},
                                                    'title': {'type': 'string'},
                                                    'winner': {'type': 'string'},
                                                    'winnerCountry': {'type': 'string'},
                                                    'winnerSize': {'type': 'string'},
                                                    'winnersOnNotice': {'type': 'number'}},
                                     'required': ['publicationNumber',
                                                  'publicationDate',
                                                  'title',
                                                  'buyer',
                                                  'buyerCountry',
                                                  'winner',
                                                  'winnerCountry',
                                                  'winnerSize',
                                                  'lei',
                                                  'noticeValue',
                                                  'currency',
                                                  'winnersOnNotice'],
                                     'type': 'object'},
                           'type': 'array'},
                'total': {'type': 'number'}},
 'required': ['total', 'awards'],
 'type': 'object'}

Companies

companies_get

A company by LEI: its contract awards and its latest annual report filing (pass the filing id to filings_facts). Value totals cover only notices the company won alone.

Input schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'properties': {'lei': {'description': 'Legal Entity Identifier, 20 characters',
                        'pattern': '^[A-Z0-9]{20}$',
                        'type': 'string'}},
 'required': ['lei'],
 'type': 'object'}
Output schema
{'$schema': 'https://json-schema.org/draft/2020-12/schema',
 'additionalProperties': False,
 'properties': {'company': {'anyOf': [{'additionalProperties': False,
                                       'properties': {'awards': {'additionalProperties': False,
                                                                 'properties': {'count': {'type': 'number'},
                                                                                'shared': {'type': 'number'},
                                                                                'soleWinnerTotals': {'items': {'additionalProperties': False,
                                                                                                               'properties': {'currency': {'type': 'string'},
                                                                                                                              'notices': {'type': 'number'},
                                                                                                                              'total': {'type': 'string'}},
                                                                                                               'required': ['currency',
                                                                                                                            'total',
                                                                                                                            'notices'],
                                                                                                               'type': 'object'},
                                                                                                     'type': 'array'}},
                                                                 'required': ['count',
                                                                              'shared',
                                                                              'soleWinnerTotals'],
                                                                 'type': 'object'},
                                                      'hasFilings': {'type': 'boolean'},
                                                      'jurisdiction': {'type': 'string'},
                                                      'latestFiling': {'anyOf': [{'additionalProperties': False,
                                                                                  'properties': {'dateAdded': {'type': 'string'},
                                                                                                 'id': {'type': 'string'},
                                                                                                 'periodEnd': {'type': ['string',
                                                                                                                        'null']}},
                                                                                  'required': ['id',
                                                                                               'periodEnd',
                                                                                               'dateAdded'],
                                                                                  'type': 'object'},
                                                                                 {'type': 'null'}]},
                                                      'lei': {'type': 'string'},
                                                      'name': {'type': 'string'},
                                                      'recentAwards': {'items': {'additionalProperties': False,
                                                                                 'properties': {'buyer': {'type': 'string'},
                                                                                                'buyerCountry': {'type': 'string'},
                                                                                                'currency': {'type': ['string',
                                                                                                                      'null']},
                                                                                                'lei': {'type': ['string',
                                                                                                                 'null']},
                                                                                                'noticeValue': {'description': 'Value '
                                                                                                                               'of '
                                                                                                                               'the '
                                                                                                                               'whole '
                                                                                                                               'award '
                                                                                                                               'notice, '
                                                                                                                               'shared '
                                                                                                                               'by '
                                                                                                                               'all '
                                                                                                                               'its '
                                                                                                                               'winners',
                                                                                                                'type': ['string',
                                                                                                                         'null']},
                                                                                                'publicationDate': {'type': 'string'},
                                                                                                'publicationNumber': {'type': 'string'},
                                                                                                'title': {'type': 'string'},
                                                                                                'winner': {'type': 'string'},
                                                                                                'winnerCountry': {'type': 'string'},
                                                                                                'winnerSize': {'type': 'string'},
                                                                                                'winnersOnNotice': {'type': 'number'}},
                                                                                 'required': ['publicationNumber',
                                                                                              'publicationDate',
                                                                                              'title',
                                                                                              'buyer',
                                                                                              'buyerCountry',
                                                                                              'winner',
                                                                                              'winnerCountry',
                                                                                              'winnerSize',
                                                                                              'lei',
                                                                                              'noticeValue',
                                                                                              'currency',
                                                                                              'winnersOnNotice'],
                                                                                 'type': 'object'},
                                                                       'type': 'array'},
                                                      'registeredAs': {'type': 'string'}},
                                       'required': ['lei',
                                                    'name',
                                                    'jurisdiction',
                                                    'registeredAs',
                                                    'hasFilings',
                                                    'awards',
                                                    'recentAwards',
                                                    'latestFiling'],
                                       'type': 'object'},
                                      {'type': 'null'}]}},
 'required': ['company'],
 'type': 'object'}