API docs by Redocly

Sonaar External API Documentation (1.0.0)

Download OpenAPI specification:

Sonaar: support@sonaar.ai

Documentation for Sonaar External API

Tenders

Tenders endpoints

List all tenders

Returns the tender list for the authenticated client API key. Visibility matches the client's CPV tender scope. Pagination is opt-in: without pageNumber / pageSize the full result set is returned in a single page.

Authorizations:
ApiKeyAuth
query Parameters
pageNumber
integer
Default: 1

Page number

pageSize
integer
Default: 10

Items per page

from
string <date>

Lower bound on publicationAt (YYYY-MM-DD)

to
string <date>

Upper bound on publicationAt (YYYY-MM-DD, inclusive, end of day)

status
string

One of AWARDED, CANCELLED, CLOSED, ENDED, ONGOING, PLANNING, UNKNOWN; prefix with - to exclude

buyerCompanyUid
string <uuid>

Restrict to a single buyer

regions
Array of strings

NUTS2 code(s), repeatable. Matched against the tender's lot-address regions; the buyer's region is not considered. Tenders with no lot-address region still match every filter.

header Parameters
X-Correlation-Id
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Get details about a given tender

Returns details for a given tender. Access is restricted to authenticated clients.

Authorizations:
ApiKeyAuth
path Parameters
uid
required
string <uuid>

Tender UID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List the documents of a given tender

Returns the documents attached to a given tender, each with a download link signed for 30 days. The tender must be within the client's CPV tender scope, otherwise 404.

Notice documents (competition notice, attribution notice, change notice, …) and XML payloads are excluded: only the tender's own files are returned. When several revisions of the same document exist, only the latest is returned, and versionNumber reports how many revisions were published.

Authorizations:
ApiKeyAuth
path Parameters
uid
required
string <uuid>

Tender UID

header Parameters
X-Correlation-Id
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Opportunities

Opportunities endpoints

List all opportunities

Returns the opportunity list for the authenticated client API key. Visibility matches the client's CPV opportunity scope, including 18-month forecast coverage. Pagination is opt-in: without pageNumber / pageSize the full result set is returned in a single page.

Authorizations:
ApiKeyAuth
query Parameters
pageNumber
integer
Default: 1

Page number

pageSize
integer
Default: 10

Items per page

regions
Array of strings

NUTS2 code(s), repeatable. Matched against the opportunity's calculated region codes.

header Parameters
X-Correlation-Id
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Get details about a given opportunity

Returns details for a given opportunity. Access is restricted to authenticated clients.

Authorizations:
ApiKeyAuth
path Parameters
uid
required
string <uuid>

Opportunity UID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Buyers

Buyers endpoints

List buyers

Returns the buyer list for the authenticated client API key. Visibility matches the client's CPV scope (buyers of in-scope tenders / in-window opportunities). Pagination is opt-in: without pageNumber / pageSize the full result set is returned in a single page.

Authorizations:
ApiKeyAuth
query Parameters
pageNumber
integer
Default: 1
pageSize
integer
Default: 100
header Parameters
X-Correlation-Id
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Get details about a given buyer

Returns details for a given buyer. Access is restricted to authenticated clients, and scoped to the client's CPV visibility: a buyer outside that scope returns 404.

Authorizations:
ApiKeyAuth
path Parameters
uid
required
string <uuid>

Buyer UID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}