TED website API

Abstract
This API provides multiple read-only operations on the TED website data. The search-controller-v3 is now available to search both TED schema notices and eForms notices. The search-controller-v3 is non-backwards compatible. Note: <a href=\"https://data.europa.eu/eli/reg_impl/2019/1780/oj\" target=\"_blank\">eForms</a> introduce a new TED schema. If you reuse TED notices, you need to adapt your systems to support the new notices. More information available on the <a href=\"https://simap.ted.europa.eu/en_GB/web/simap/eforms\" target=\"_blank\">dedicated SIMAP page</a>. <a href=\"https://ted.europa.eu/TED/misc/legalNotice.do\" target=\"_blank\">Terms of service</a> <a href=\"https://ted.europa.eu/TED/main/HomePage.do\" target=\"_blank\">TED - Website</a> <a href=\"https://ted.europa.eu/TED/misc/contact.do\" target=\"_blank\">Contact</a> <a href=\"https://ted.europa.eu/TED/misc/legalNotice.do\" target=\"_blank\">Legal notice</a>

Endpoints

SearchControllerV1

searchGetUsingGET

GET /api/v1.0/notices/search

Search for notices using expert search query

Description

For more information in the query format or field names, please consult https://ted.europa.eu/TED/misc/helpPage.do?helpPageId=expertSearch. If your URL length is too long, use the POST method.

Parameters
Query Parameters
Name Description Required Default Pattern

apiKey

API key

X

null

fields

description&quot;:&quot;The list of field names to return for each notice. CONTENT is the notice in XML encoded in base64. If a field indicated here has no value for a notice, it will be omitted in the response. [String]

-

null

pageNum

Current page number. The page number is 1-based

-

1

pageSize

Number of results per page. This value is capped at 100 when the CONTENT field is requested, otherwise it is capped at 1000.

-

0

q

Search query

X

null

reverseOrder

Display the results in reverse order

-

false

scope

Search scope. 1 for 'Last edition'; 2 for 'Active'; 3 for 'All'

-

1

sortField

Field for sorting the search results

-

ND
Return Type

SearchResponseV1 SearchResponseV1

Content Type

  • application/json

Responses
Table 1. http response codes
Code Message Datatype

200

OK

SearchResponseV1 SearchResponseV1

401

Unauthorized

<<>>

403

Forbidden

<<>>

404

Not Found

<<>>
Samples

searchPostUsingPOST

POST /api/v1.0/notices/search

Search for notices using expert search query

Description

Search for notices

Parameters
Body Parameter
Name Description Required Default Pattern

searchRestRequest

searchRestRequest OldSearchRestRequest OldSearchRestRequest

-
Return Type

SearchResponseV1 SearchResponseV1

Content Type

  • application/json

Responses
Table 2. http response codes
Code Message Datatype

200

OK

SearchResponseV1 SearchResponseV1

201

Created

<<>>

401

Unauthorized

<<>>

403

Forbidden

<<>>

404

Not Found

<<>>
Samples

SearchControllerV2

retrieveNoticesNutsCountUsingGET

GET /api/v2.0/notices/attributes/nuts/count

Search for notices for map

Description

Gets notices by nuts code for the browse by map feature

Parameters
Query Parameters
Name Description Required Default Pattern

apiKey

API key

-

null

scope

Search scope. 1 for 'Last edition'; 2 for 'Active'

-

1
Return Type

SearchDataMapResponse SearchDataMapResponse

Content Type

  • application/json

Responses
Table 3. http response codes
Code Message Datatype

200

OK

SearchDataMapResponse SearchDataMapResponse

401

Unauthorized

<<>>

403

Forbidden

<<>>

404

Not Found

<<>>
Samples

searchGetUsingGET1

GET /api/v2.0/notices/search

Search for notices using expert search query

Description

For more information in the query format or field names, please consult https://ted.europa.eu/TED/misc/helpPage.do?helpPageId=expertSearch. If your URL length is too long, use the POST method.

Parameters
Query Parameters
Name Description Required Default Pattern

apiKey

API key

-

null

fields

The list of field names to return for each notice. CONTENT is the notice in XML encoded in base64. If a field indicated here has no value for a notice, it will be omitted in the response. [String]

-

null

pageNum

Number of the current page

-

1

pageSize

Number of results per page. This value is capped at 100 when the CONTENT field is requested, otherwise it is capped at 1000.

-

null

q

Search query

X

null

reverseOrder

Display the result in reverse order

-

false

scope

Search scope. 1 for 'Last edition'; 2 for 'Active notices'; 3 for 'All'

-

1

sortField

Field for sorting of search results

-

ND
Return Type

SearchResponseV2 SearchResponseV2

Content Type

  • application/json

Responses
Table 4. http response codes
Code Message Datatype

200

OK

SearchResponseV2 SearchResponseV2

401

Unauthorized

<<>>

403

Forbidden

<<>>

404

Not Found

<<>>
Samples

searchPostUsingPOST1

POST /api/v2.0/notices/search

Search for notices using expert search query

Description

Search for notices

Parameters
Body Parameter
Name Description Required Default Pattern

oldSearchRestRequest

oldSearchRestRequest OldSearchRestRequest OldSearchRestRequest

-
Return Type

SearchResponseV2 SearchResponseV2

Content Type

  • application/json

Responses
Table 5. http response codes
Code Message Datatype

200

OK

SearchResponseV2 SearchResponseV2

201

Created

<<>>

401

Unauthorized

<<>>

403

Forbidden

<<>>

404

Not Found

<<>>
Samples

SearchControllerV3

retrieveNoticesNutsCountUsingGET1

GET /api/v3.0/notices/attributes/nuts/count

Search for notices for map

Description

Gets notices by nuts code for the browse by map feature

Parameters
Query Parameters
Name Description Required Default Pattern

apiKey

API key

-

null

scope

Search scope. 1 for 'Last edition'; 2 for 'Active'

-

1
Return Type

SearchDataMapResponse SearchDataMapResponse

Content Type

  • application/json

Responses
Table 6. http response codes
Code Message Datatype

200

OK

SearchDataMapResponse SearchDataMapResponse

401

Unauthorized

<<>>

403

Forbidden

<<>>

404

Not Found

<<>>
Samples

searchGetUsingGET2

GET /api/v3.0/notices/search

Search for notices using expert search query

Description

For more information in the query format or field names, please consult https://ted.europa.eu/TED/misc/helpPage.do?helpPageId=expertSearch. If your URL length is too long, use the POST method.

Parameters
Query Parameters
Name Description Required Default Pattern

apiKey

API key

-

null

fields

The list of field names to return for each notice. CONTENT is the notice in XML encoded in base64. If a field indicated here has no value for a notice, it will be omitted in the response. [String]

-

null

pageNum

Number of the current page

-

1

pageSize

Number of results per page. This value is capped at 100 when the CONTENT field is requested, otherwise it is capped at 1000.

-

null

q

Search query

X

null

reverseOrder

Display the result in reverse order

-

false

scope

Search scope. 1 for 'Last edition'; 2 for 'Active notices'; 3 for 'All'

-

1

sortField

Field for sorting of search results

-

ND
Return Type

SearchResponseV3 SearchResponseV3

Content Type

  • application/json

Responses
Table 7. http response codes
Code Message Datatype

200

OK

SearchResponseV3 SearchResponseV3

401

Unauthorized

<<>>

403

Forbidden

<<>>

404

Not Found

<<>>
Samples

searchPostUsingPOST2

POST /api/v3.0/notices/search

Search for notices using expert search query

Description

Search for notices

Parameters
Body Parameter
Name Description Required Default Pattern

searchRestRequest

searchRestRequest SearchRestRequest SearchRestRequest

-
Return Type

SearchResponseV3 SearchResponseV3

Content Type

  • application/json

Responses
Table 8. http response codes
Code Message Datatype

200

OK

SearchResponseV3 SearchResponseV3

201

Created

<<>>

401

Unauthorized

<<>>

403

Forbidden

<<>>

404

Not Found

<<>>
Samples

Models

MappingJacksonValue MappingJacksonValue

Field Name Required Type Description Format

filters

Object

jsonpFunction

String

value

Object

OldSearchRestRequest OldSearchRestRequest

Field Name Required Type Description Format

apiKey

String

fields

List of [string]

Enum:

pageNum

Integer

int32

pageSize

Integer

int32

q

String

reverseOrder

Boolean

scope

Integer

int32

sortField

String

RestNoticeResultV1 RestNoticeResultV1

Field Name Required Type Description Format

AA

String

AC

String

CY

String

DD

date

date

DI

String

DS

date

date

DT

date

date

MA

String

NC

String

ND

Integer

int32

OC

List of [string]

OJ

Integer

int32

OL

String

OY

List of [string]

PC

List of [string]

PD

date

date

PR

String

RC

List of [string]

RN

Integer

int32

RP

String

TD

String

TY

String

content

byte[]

byte

RestNoticeResultV2 RestNoticeResultV2

Field Name Required Type Description Format

AA

String

AC

String

BI

List of [string]

CY

String

DD

date

date

DI

String

DS

date

date

DT

date

date

MA

String

NC

String

ND

String

NL

Long

int64

OC

List of [string]

OJ

String

OL

String

OY

List of [string]

PC

List of [string]

PD

date

date

PR

String

RC

List of [string]

RN

Integer

int32

RP

String

TD

String

TVH

String

TVL

String

TY

String

content

byte[]

byte

RestNoticeResultV3 RestNoticeResultV3

Field Name Required Type Description Format

AA

List of [string]

AC

String

BI

List of [string]

CY

List of [string]

DD

date

date

DI

String

DS

date

date

DT

List of [string]

MA

List of [string]

NC

List of [string]

ND

String

NL

Long

int64

OC

List of [string]

OJ

String

OL

String

OY

List of [string]

PC

List of [string]

PD

date

date

PR

String

RC

List of [string]

RN

List of [integer]

int32

RP

String

TD

String

TVH

String

TVL

String

TY

String

award-criterion-type

List of [string]

content

byte[]

byte

corporate-body

List of [string]

funding

List of [string]

notice-identifier

String

notice-type

String

notice-version

String

SearchDataMapResponse SearchDataMapResponse

Field Name Required Type Description Format

results

Map of [long]

int64

took

Long

int64

total

Integer

int32

SearchResponseV1 SearchResponseV1

Field Name Required Type Description Format

results

List of RestNoticeResultV1 RestNoticeResultV1

took

Long

int64

total

Integer

int32

SearchResponseV2 SearchResponseV2

Field Name Required Type Description Format

results

List of RestNoticeResultV2 RestNoticeResultV2

took

Long

int64

total

Integer

int32

SearchResponseV3 SearchResponseV3

Field Name Required Type Description Format

results

List of RestNoticeResultV3 RestNoticeResultV3

took

Long

int64

total

Integer

int32

SearchRestRequest SearchRestRequest

Field Name Required Type Description Format

apiKey

String

fields

List of [string]

Enum:

pageNum

Integer

int32

pageSize

Integer

int32

q

String

reverseOrder

Boolean

scope

Integer

int32

sortField

String