Introduction
This document sets out to describe the mechanisms by which eSenders and others can feed their opportunities to the Find a Tender service,
and retrieve data regarding their submission.
Scope and purpose
The purpose of this document is to provide the required information to operate the Find a Tender REST API.
The Find a Tender application provides a REST API based on JSON to other applications in order to expose its services.
The Find a Tender application will expose the following REST operations:
Technical Specification
REST
Representational State Transfer (REST) is an architectural style based on the architecture of the Web and embraces HTTP.
Clients initiate requests to servers; servers process requests and return appropriate responses.
Requests and responses are built around the transfer of "representations" of "resources".
Authentication
Authentication is required to access the Find a Tender REST API.
To access the Find a Tender REST API clients must be authenticated using standard HTTP API Key authentication over HTTPS.
Credentials
Find a Tender REST API clients use the CDP API Key generated by their organisation.
Simple cURL example
curl -X GET -H "Accept: application/json" -H 'CDP-Api-Key: YOUR_CDP_API_KEY';
https://www.find-tender.service.gov.uk/api/latest/notice/submission/info/20250430-123456
Supplying Basic Auth headers
- Copy the CDP API key generated by your organisation.
- Add your CDP API key to the API request as follows:
curl -X GET -H "CDP-Api-Key: YbHJy1zPfMgDfa9npEDBtZ05ji0w2OM7M" -H "Accept: application/json" https://www.find-tender.service.gov.uk/api/latest/notice/submission/info/20250430-123456
Mappings
Email Addresses
Email addresses must confirm with the standard pattern, i.e. similar to given.family@domain.ext. There is no further validation checking.
Interface specification
Find a Tender API
Please note, for use of the methods below, {version} may be specified as '1' or 'latest' e.g. /api/latest/notice/submission/submit
Input methods
API | Description |
POST /api/{version}/notice/submission/submit |
Request for publication of a procurement notice in OJ S (formatted as a document in 2.0.8 or 2.0.9 standard).
|
POST /api/{version}/notice/attachment/submit |
Upload an attachment encoded in BASE64.
|
Output methods
API | Description |
Version 2 = GET /api/2/notice/submission/info/{submission_id}
Version 1 = GET /api/1/notice/submission/info/{submission_id}
|
Gets notice information for a published or non published notice as a NoticeInformation object.
|
GET /api/{version}/notice/submission/search |
Searches all (published and non published) notice submissions of the eSender based on the parameters provided.
|
POST /api/{version}/notice/submission/render |
Renders in either HTML or PDF format a submitted notice or a valid Reception XML
|