MARS documentation
API reference

Get bond

Contract and client context

Operation: get_bond · HTTP: GET /v1/bonds/{bond_id}

Use an operator-supplied registry base URL. Request execution is disabled in this documentation explorer. Generated request snippets are templates, not signed or authorized submissions.

Exact operation definition
{
  "operationId": "get_bond",
  "parameters": [
    {
      "description": "Bond identifier",
      "in": "path",
      "name": "bond_id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Bond"
          }
        }
      },
      "description": "Bond record"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Bond not found"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Read rate limit exceeded"
    }
  },
  "tags": [
    "trust"
  ]
}

Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.

GET/v1/bonds/{bond_id}

Path Parameters

bond_id*string

Bond identifier

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/bonds/string"
{  "amount": "string",  "bondId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "currency": "string",  "entryDid": "string",  "publisherDid": "string",  "registryDid": "string",  "slashHistory": [    {      "amount": "string",      "distribution": {        "harmedPartiesShare": "string",        "reporterShare": "string",        "treasuryShare": "string"      },      "reason": "string",      "reporterDid": "string",      "timestamp": "2019-08-24T14:15:22Z"    }  ],  "status": "active"}