Bulk request

POST /api/ledger/v2/{ledger}/_bulk

Try it

Bulk request

cURL

curl --request POST \
  --url http://localhost/api/ledger/v2/{ledger}/_bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "action": "<string>",
    "ik": "<string>",
    "data": {
      "metadata": {
        "admin": "true"
      },
      "timestamp": "2023-11-07T05:31:56Z",
      "postings": [
        {
          "amount": 100,
          "asset": "COIN",
          "destination": "users:002",
          "source": "users:001"
        }
      ],
      "script": {
        "plain": "vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n",
        "vars": {
          "user": "users:042"
        }
      },
      "runtime": "experimental-interpreter",
      "reference": "ref:001",
      "accountMetadata": {},
      "force": true
    }
  }
]
'

200

{
  "data": [
    {
      "responseType": "<string>",
      "logID": 123,
      "data": {
        "timestamp": "2023-11-07T05:31:56Z",
        "postings": [
          {
            "amount": 100,
            "asset": "COIN",
            "destination": "users:002",
            "source": "users:001"
          }
        ],
        "metadata": {
          "admin": "true"
        },
        "id": 1,
        "reverted": true,
        "insertedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "reference": "ref:001",
        "revertedAt": "2023-11-07T05:31:56Z",
        "preCommitVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        },
        "postCommitVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        },
        "preCommitEffectiveVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        },
        "postCommitEffectiveVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        }
      }
    }
  ],
  "errorCode": "VALIDATION",
  "errorMessage": "[VALIDATION] invalid 'cursor' query param"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

ledger · string · required

Name of the ledger.

Example:

"ledger001"

Query Parameters

continueOnFailure · boolean

Continue on failure

Example:

true

atomic · boolean

Make bulk atomic

Example:

true

parallel · boolean

Process bulk elements in parallel

Example:

true

Body

application/json

Option 1

action · string · required

ik · string

data · object

Show child attributes

data. metadata · object · required

Show child attributes

data.metadata. {key} · string

Example:

{ "admin": "true" }

data. timestamp · string<date-time>

data. postings · object[]

Show child attributes

data.postings. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.postings. asset · string · required

Example:

"COIN"

data.postings. destination · string · required

Example:

"users:002"

data.postings. source · string · required

Example:

"users:001"

data. script · object

Show child attributes

data.script. plain · string · required

Example:

"vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n"

data.script. vars · object

Show child attributes

data.script.vars. {key} · string

Example:

{ "user": "users:042" }

data. runtime · enum<string>

The numscript runtime used to execute the script. Uses "machine" by default, unless the "--experimental-numscript-interpreter" feature flag is passed.

Available options: experimental-interpreter, machine

data. reference · string

Example:

"ref:001"

data. accountMetadata · object

Show child attributes

data.accountMetadata. {key} · object

Show child attributes

data.accountMetadata.{key}. {key} · string

Example:

{ "admin": "true" }

data. force · boolean

Response

200

application/json

OK

data · object[]

Option 1

Show child attributes

data. responseType · string · required

data. logID · integer · required

data. data · object · required

Show child attributes

data.data. timestamp · string<date-time> · required

data.data. postings · object[] · required

Show child attributes

data.data.postings. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.data.postings. asset · string · required

Example:

"COIN"

data.data.postings. destination · string · required

Example:

"users:002"

data.data.postings. source · string · required

Example:

"users:001"

data.data. metadata · object · required

Show child attributes

data.data.metadata. {key} · string

Example:

{ "admin": "true" }

data.data. id · integer<bigint> · required

Required range: x >= 0

data.data. reverted · boolean · required

data.data. insertedAt · string<date-time>

data.data. updatedAt · string<date-time>

data.data. reference · string

Example:

"ref:001"

data.data. revertedAt · string<date-time>

data.data. preCommitVolumes · object

Show child attributes

data.data.preCommitVolumes. {key} · object

Show child attributes

data.data.preCommitVolumes.{key}. {key} · object

Show child attributes

data.data.preCommitVolumes.{key}.{key}. input · integer<bigint> · required

data.data.preCommitVolumes.{key}.{key}. output · integer<bigint> · required

data.data.preCommitVolumes.{key}.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

Example:

{
  "orders:1": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  },
  "orders:2": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  }
}

data.data. postCommitVolumes · object

Show child attributes

data.data.postCommitVolumes. {key} · object

Show child attributes

data.data.postCommitVolumes.{key}. {key} · object

Show child attributes

data.data.postCommitVolumes.{key}.{key}. input · integer<bigint> · required

data.data.postCommitVolumes.{key}.{key}. output · integer<bigint> · required

data.data.postCommitVolumes.{key}.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

Example:

{
  "orders:1": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  },
  "orders:2": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  }
}

data.data. preCommitEffectiveVolumes · object

Show child attributes

data.data.preCommitEffectiveVolumes. {key} · object

Show child attributes

data.data.preCommitEffectiveVolumes.{key}. {key} · object

Show child attributes

data.data.preCommitEffectiveVolumes.{key}.{key}. input · integer<bigint> · required

data.data.preCommitEffectiveVolumes.{key}.{key}. output · integer<bigint> · required

data.data.preCommitEffectiveVolumes.{key}.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

Example:

{
  "orders:1": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  },
  "orders:2": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  }
}

data.data. postCommitEffectiveVolumes · object

Show child attributes

data.data.postCommitEffectiveVolumes. {key} · object

Show child attributes

data.data.postCommitEffectiveVolumes.{key}. {key} · object

Show child attributes

data.data.postCommitEffectiveVolumes.{key}.{key}. input · integer<bigint> · required

data.data.postCommitEffectiveVolumes.{key}.{key}. output · integer<bigint> · required

data.data.postCommitEffectiveVolumes.{key}.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

Example:

{
  "orders:1": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  },
  "orders:2": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  }
}

errorCode · enum<string>

Available options: INTERNAL, INSUFFICIENT_FUND, VALIDATION, CONFLICT, COMPILATION_FAILED, METADATA_OVERRIDE, NOT_FOUND, REVERT_OCCURRING, ALREADY_REVERT, NO_POSTINGS, LEDGER_NOT_FOUND, IMPORT, TIMEOUT, BULK_SIZE_EXCEEDED, INTERPRETER_PARSE, INTERPRETER_RUNTIME, LEDGER_ALREADY_EXISTS, OUTDATED_SCHEMA

Example:

"VALIDATION"

errorMessage · string

Example:

"[VALIDATION] invalid 'cursor' query param"