Skip to main content
POST
Get backend co-signature for vault.mergePositions

Authorizations

X-Api-Key
string
header
required

Partner / integrator key — format ps_live_<keyId>_<secret>. Partner keys are issued by PredictStreet; a user can also create keys bound to their own wallet from their account settings in the web app. Never ship to a browser. multi_wallet partners must additionally send X-User-Wallet: 0x<40-hex> on every authenticated request to declare the acting wallet. See the API keys guide for scope taxonomy, partner kinds, rate limits, and rotation procedure.

Headers

X-User-Wallet
string

Required for multi_wallet partners on every authenticated request; ignored for single_wallet. Declares the acting end-user wallet for this request — drives KYC checks, balances/positions/orders attribution, rate-limit buckets, and audit. Lower-cased server-side. Missing on a multi_wallet key → 401 api_key_user_wallet_required; malformed → 401 api_key_user_wallet_invalid. The on-chain CTFExchange/Vault contracts still verify EIP-712 signer ↔ vault binding, so loosening API-layer attribution is safe by construction.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

idempotency-key
string

Optional. Requests carrying the same key replay the original operation instead of creating a new one. When omitted, the key is derived from the wallet, the operation and the exact request body, so a byte-identical repeat replays the first operation — send your own key to run the same operation twice.

Body

application/json
marketId
string
required
Example:

"NC26-BIN-83479265"

amount
string
required

Decimal USDC amount the merge unwraps. Burns equal units of YES + NO inside the vault and credits this much USDC.

Example:

"30"

outcomeIndex
integer

Required on neg-risk markets: selects the sub-question whose conditionId is signed (without it: 400 outcome_index_required). Ignored on binary markets.

Required range: 0 <= x <= 254

Response

Backend co-signature ready

signedOpId
string<uuid>
required

Id of the co-signed op; pass it to POST /api/me/positions/op-submit.

digest
string
required

EIP-712 digest the vault owner signs (the ownerSig for op-submit).

kind
integer
required

0 = binary, 1 = neg-risk.

collateralToken
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

conditionId
string
required
Pattern: ^0x[0-9a-fA-F]{64}$
partition
string[]
required
Example:
salt
string
required
deadline
integer
required
vaultAddress
string
required

EIP-712 verifyingContract for the MergePositions struct (the vault, not the factory).

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

backendSig
string
required

Backend co-signature; pair with the owner's EIP-712 signature in vault.mergePositions(...).

Pattern: ^0x[a-fA-F0-9]+$
amount
string

USDC wei (6-decimal).

outcomeIndex
integer

Echoed back on neg-risk markets: the sub-question whose conditionId was signed. Absent on binary markets.