Pact

GET/api/v1/pacts

List_pacts

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.

q?string

Full-text search over this list's searchable fields.

Length1 <= length <= 200

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: title, updated_at, created_at. Default: -created_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/pacts"

{  "pacts": [    {      "claim_ttl_seconds": 0,      "claimant": "string",      "contributions": [        {          "amount": 0,          "contributor_id": "string",          "joined_at": "2019-08-24T14:15:22Z"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "creator_fee_bps": 0,      "deadline": "2019-08-24T14:15:22Z",      "description": "string",      "dispute": null,      "dispute_window_seconds": 0,      "domain": "string",      "forfeit_destination": {        "kind": "sink"      },      "kind": "oath",      "metadata": null,      "outcomes": [        {          "label": "string",          "outcome_id": "string",          "pool": 0        }      ],      "pact_id": "string",      "pool_config": {        "beneficiary_id": "string",        "payout_amount": 0      },      "receipt": null,      "resolution": null,      "stake": {        "amount": 0,        "currency_id": "string",        "escrow_transfer_id": "string",        "escrow_wallet": "string"      },      "status": "open",      "title": "string",      "updated_at": "2019-08-24T14:15:22Z",      "verifier": {        "approvers": [          "string"        ],        "kind": "manual",        "required_approvers": 0,        "rubric": "string"      }    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  }}

POST/api/v1/pacts

Create_pact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

claim_ttl_seconds?|

Claim TTL in seconds for bounties (defaults to config).

Formatint64

creator_fee_bps?|

Creator fee in basis points taken from a market's losing pool on settlement.

Formatint32

Range0 <= value

currency_id*string

Treasury currency id the stake is denominated in.

deadline?|

Optional resolution/lock deadline.

Formatdate-time

description?|

Optional description.

dispute_window_seconds?|

Dispute-window duration in seconds (defaults to config).

Formatint64

domain*string

Treasury domain whose currency and wallets this pact escrows against.

forfeit_destination?||

Where a failed oath / forfeited stake is routed.

kind?PactKind

Pact kind: oath, bounty, market, or pool.

Value in

"oath"
"bounty"
"market"
"pool"

outcomes?array<>

Market outcomes (required for kind=market, 2..=N).

pool_beneficiary_id?|

Pool payout beneficiary (kind=pool); defaults to creator.

pool_payout_amount?|

Pool parametric payout amount (kind=pool).

Formatint64

stake_amount?integer

Stake amount escrowed at creation (oath/bounty/pool seed) or position size baseline. For markets and pools, this is the creator's initial escrow (may be 0 for markets).

Formatint64

title*string

Title of the pact.

verifier?

Verifier configuration.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/pacts" \  -H "Content-Type: application/json" \  -d '{    "currency_id": "string",    "domain": "string",    "title": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "kind": "oath",  "pact_id": "string",  "stake": {    "amount": 0,    "currency_id": "string",    "escrow_transfer_id": "string",    "escrow_wallet": "string"  },  "status": "open"}

GET/api/v1/pacts/{pact_id}

Get_pact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

pact_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/pacts/string"

{  "claim_ttl_seconds": 0,  "claimant": "string",  "contributions": [    {      "amount": 0,      "contributor_id": "string",      "joined_at": "2019-08-24T14:15:22Z"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "creator_fee_bps": 0,  "deadline": "2019-08-24T14:15:22Z",  "description": "string",  "dispute": null,  "dispute_window_seconds": 0,  "domain": "string",  "forfeit_destination": {    "kind": "sink"  },  "kind": "oath",  "metadata": null,  "outcomes": [    {      "label": "string",      "outcome_id": "string",      "pool": 0    }  ],  "pact_id": "string",  "pool_config": {    "beneficiary_id": "string",    "payout_amount": 0  },  "receipt": null,  "resolution": null,  "stake": {    "amount": 0,    "currency_id": "string",    "escrow_transfer_id": "string",    "escrow_wallet": "string"  },  "status": "open",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z",  "verifier": {    "approvers": [      "string"    ],    "kind": "manual",    "required_approvers": 0,    "rubric": "string"  }}

POST/api/v1/pacts/{pact_id}/claims

Claim_bounty

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

pact_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/pacts/string/claims"

{  "claimant": "string",  "expires_at": "2019-08-24T14:15:22Z",  "pact_id": "string",  "status": "open"}

POST/api/v1/pacts/{pact_id}/disputes

File_dispute

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

pact_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

statement*string

The challenger's statement of why the resolution is wrong.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/pacts/string/disputes" \  -H "Content-Type: application/json" \  -d '{    "statement": "string"  }'

{  "dispute": {    "bond_amount": 0,    "bond_wallet": "string",    "challenger_id": "string",    "dispute_id": "string",    "external_ref": "string",    "filed_at": "2019-08-24T14:15:22Z",    "resolved_at": "2019-08-24T14:15:22Z",    "statement": "string",    "status": "under_review"  },  "pact_id": "string",  "status": "open"}

POST/api/v1/pacts/{pact_id}/disputes/resolve

Resolve_dispute

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

pact_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

uphold*boolean

Whether the dispute is upheld (resolution rewinds) or dismissed (bond forfeited).

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/pacts/string/disputes/resolve" \  -H "Content-Type: application/json" \  -d '{    "uphold": true  }'

{  "dispute": null,  "pact_id": "string",  "receipt": null,  "status": "open"}

POST/api/v1/pacts/{pact_id}/join

Join_pool

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

pact_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*integer

Premium / contribution amount.

Formatint64

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/pacts/string/join" \  -H "Content-Type: application/json" \  -d '{    "amount": 0  }'

{  "claim_ttl_seconds": 0,  "claimant": "string",  "contributions": [    {      "amount": 0,      "contributor_id": "string",      "joined_at": "2019-08-24T14:15:22Z"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "creator_fee_bps": 0,  "deadline": "2019-08-24T14:15:22Z",  "description": "string",  "dispute": null,  "dispute_window_seconds": 0,  "domain": "string",  "forfeit_destination": {    "kind": "sink"  },  "kind": "oath",  "metadata": null,  "outcomes": [    {      "label": "string",      "outcome_id": "string",      "pool": 0    }  ],  "pact_id": "string",  "pool_config": {    "beneficiary_id": "string",    "payout_amount": 0  },  "receipt": null,  "resolution": null,  "stake": {    "amount": 0,    "currency_id": "string",    "escrow_transfer_id": "string",    "escrow_wallet": "string"  },  "status": "open",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z",  "verifier": {    "approvers": [      "string"    ],    "kind": "manual",    "required_approvers": 0,    "rubric": "string"  }}

POST/api/v1/pacts/{pact_id}/positions

Place_position

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

pact_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*integer

Stake amount.

Formatint64

outcome_id*string

Outcome to stake on.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/pacts/string/positions" \  -H "Content-Type: application/json" \  -d '{    "amount": 0,    "outcome_id": "string"  }'

{  "implied_odds": 0.1,  "position": {    "amount": 0,    "created_at": "2019-08-24T14:15:22Z",    "holder_id": "string",    "outcome_id": "string",    "pact_id": "string",    "payout": 0,    "position_id": "string",    "settled": true  },  "total_pool": 0}

POST/api/v1/pacts/{pact_id}/resolve

Resolve_pact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

pact_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

evidence?|

Free-form evidence handed to the verifier (arbiter content / hitl context).

fulfilled?boolean

For oath/bounty/pool: whether the commitment was fulfilled / claim accepted / covered event verified.

outcome_id?|

For markets: the winning outcome id. Omit for oath/bounty/pool.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/pacts/string/resolve" \  -H "Content-Type: application/json" \  -d '{}'

{  "pact_id": "string",  "receipt": null,  "resolution": null,  "status": "open"}

POST/api/v1/pacts/{pact_id}/void

Void_pact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

pact_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?|

Optional reason recorded with the void.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/pacts/string/void" \  -H "Content-Type: application/json" \  -d '{}'

{  "claim_ttl_seconds": 0,  "claimant": "string",  "contributions": [    {      "amount": 0,      "contributor_id": "string",      "joined_at": "2019-08-24T14:15:22Z"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "creator_fee_bps": 0,  "deadline": "2019-08-24T14:15:22Z",  "description": "string",  "dispute": null,  "dispute_window_seconds": 0,  "domain": "string",  "forfeit_destination": {    "kind": "sink"  },  "kind": "oath",  "metadata": null,  "outcomes": [    {      "label": "string",      "outcome_id": "string",      "pool": 0    }  ],  "pact_id": "string",  "pool_config": {    "beneficiary_id": "string",    "payout_amount": 0  },  "receipt": null,  "resolution": null,  "stake": {    "amount": 0,    "currency_id": "string",    "escrow_transfer_id": "string",    "escrow_wallet": "string"  },  "status": "open",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z",  "verifier": {    "approvers": [      "string"    ],    "kind": "manual",    "required_approvers": 0,    "rubric": "string"  }}

GET/api/v1/positions

List_positions

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

filter?

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: created_at. Default: -created_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/positions"

{  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  },  "positions": [    {      "amount": 0,      "created_at": "2019-08-24T14:15:22Z",      "holder_id": "string",      "outcome_id": "string",      "pact_id": "string",      "payout": 0,      "position_id": "string",      "settled": true    }  ]}

200application/json

400

503

201application/json

400

503

200application/json

404

503

200application/json

403

404

409

503

201application/json

404

409

503

200application/json

403

404

409

503

200application/json

400

404

409

503

201application/json

400

403

404

409

503

200application/json

400

403

404

409

503

200application/json

403

404

409

503

200application/json

400

503

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`