Get a campaign

One campaign

GET/v1/campaigns/{campaignId}

Request

A client sends this request signed with its credential. The example is signed with the test API key test-key-test-key and the test secret docs-example-signing, at the timestamp 1767225600 with the nonce docs-example-nonce-0001; see Authentication and signing.

Headers

Name
X-Api-Key
Type
string, required
Description
The credential id. Sent together with X-Timestamp, X-Nonce and X-Signature.
Name
X-Signature
Type
string, required
Description
Base64 HMAC-SHA256 of the method, the path with its query, X-Timestamp, X-Nonce and the lowercase hex SHA-256 of the raw body, joined by newlines. Compared in constant time; 30 seconds of tolerance; each nonce is used once.
Name
X-Timestamp
Type
string, required
Description
Unix seconds; within 30 seconds of the receiver's clock. Matches ^[0-9]{1,12}$.
Name
X-Nonce
Type
string, required
Description
Single use per credential, kept until the timestamp plus 30 seconds. At least 16 characters. At most 128 characters.

Path parameters

Name
campaignId
Type
string (uuid), required
Description
A UUID v7.

Request

GET

/v1/campaigns/{campaignId}

curl "https://aggregator.asteriks.casino/v1/campaigns/0199c5a0-0000-7000-8000-000000000009" \
  -H "X-Api-Key: test-key-test-key" \
  -H "X-Timestamp: 1767225600" \
  -H "X-Nonce: docs-example-nonce-0001" \
  -H "X-Signature: N/j8iITAVjE4/tjgSdJSVfuiEDo53sS0utinoT5B8XM="

200

Response

The answer is 200 with application/json.

Name
id
Type
string (uuid), required
Description
A UUID v7.
Name
code
Type
string, required
Description
The client's campaign code, unique per client. Matches ^[A-Za-z0-9_.:-]{1,64}$.
Name
provider
Type
string, required
Description
One of drakon, cocktail, games360, betting_software, electrobets.
Name
vendor
Type
string | null, required
Description
Name
currency
Type
string, required
Description
One of TRY, EUR, USD, USDT, TON, BTC, AED, AFN, ALL, AMD, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TTD, TWD, TZS, UAH, UGX, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XCG, XOF, XPF, YER, ZAR, ZMW, ZWG.
Name
rounds_per_player
Type
integer, required
Description
At least 1. At most 2147483647.
Name
begins_at
Type
string (date-time), required
Description
Name
expires_at
Type
string (date-time), required
Description
Name
status
Type
string, required
Description
One of draft, active, cancelled, expired.
Name
games
Type
object[], required
Description
Name
games[].game_id
Type
string (uuid), required
Description
A UUID v7.
Name
games[].bet_level
Type
integer, required
Description
The free round's bet in minor units of the campaign currency, one of the provider's levels. At least 1. At most 9007199254740991.
Name
created_at
Type
string (date-time), required
Description
Name
cancelled_at
Type
string (date-time) | null, required
Description
Name
expired_at
Type
string (date-time) | null, required
Description

Errors

Each error carries one of these codes in the error object of Errors.

Name
MALFORMED_REQUEST
Type
400
Description
MALFORMED_REQUEST: a body, query or path value fails its schema.
Name
UNAUTHORIZED
Type
401
Description
UNAUTHORIZED: a missing or wrong key, signature, timestamp or nonce.
Name
NOT_FOUND
Type
404
Description
NOT_FOUND: an unknown id, another client's id or an unknown path; one body for every 404.

Response

{
  "id": "0199c5a0-0000-7000-8000-000000000002",
  "code": "text",
  "provider": "drakon",
  "vendor": "text",
  "currency": "EUR",
  "rounds_per_player": 1,
  "begins_at": "2026-10-13T12:00:00Z",
  "expires_at": "2026-10-20T12:00:00Z",
  "status": "draft",
  "games": [
    {
      "game_id": "0199c5a0-0000-7000-8000-000000000002",
      "bet_level": 1
    }
  ],
  "created_at": "2026-10-13T12:00:00Z",
  "cancelled_at": null,
  "expired_at": null
}