Queries
action
Response
Returns an
Arguments
Name
Description
where
-
Example
Query
Copy query Action($where: ActionWhereInput) {
action(where: $where) {
id
type
configuration
}
}
Variables
Copy {"where": ActionWhereInput}
Response
Copy {
"data": {
"action": {
"id": "xyz789",
"type": "xyz789",
"configuration": {}
}
}
}
actions
Response
Arguments
Name
Description
Example
Query
Copy query Actions(
$where: ActionWhereInput,
$take: Int,
$skip: Int,
$gt: ActionWhereInput,
$lt: ActionWhereInput,
$like: ActionWhereInput,
$orderBy: [JSONObject]
) {
actions(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
type
configuration
}
count
}
}
Variables
Copy {
"where": ActionWhereInput,
"take": 987,
"skip": 123,
"gt": ActionWhereInput,
"lt": ActionWhereInput,
"like": ActionWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"actions": {"data": [Action], "count": 123}}}
address
Response
Arguments
Name
Description
Example
Query
Copy query Address($where: AddressWhereInput) {
address(where: $where) {
id
value
publicKey
type
meta
escrow {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
}
}
Variables
Copy {"where": AddressWhereInput}
Response
Copy {
"data": {
"address": {
"id": "abc123",
"value": "abc123",
"publicKey": "abc123",
"type": "xyz789",
"meta": {},
"escrow": Escrow
}
}
}
addresses
Response
Arguments
Name
Description
Example
Query
Copy query Addresses(
$where: AddressWhereInput,
$take: Int,
$skip: Int,
$gt: AddressWhereInput,
$lt: AddressWhereInput,
$like: AddressWhereInput,
$orderBy: [JSONObject]
) {
addresses(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
value
publicKey
type
meta
escrow {
...EscrowFragment
}
}
count
}
}
Variables
Copy {
"where": AddressWhereInput,
"take": 987,
"skip": 987,
"gt": AddressWhereInput,
"lt": AddressWhereInput,
"like": AddressWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"addresses": {"data": [Address], "count": 987}}}
asset
Response
Arguments
Name
Description
Example
Query
Copy query Asset($where: AssetWhereInput) {
asset(where: $where) {
id
type
usdValue
content {
meta
node
}
collateral {
id
assets {
...AssetFragment
}
escrow {
...EscrowFragment
}
}
addresses {
id
value
publicKey
type
meta
escrow {
...EscrowFragment
}
}
action {
id
type
configuration
}
}
}
Variables
Copy {"where": AssetWhereInput}
Response
Copy {
"data": {
"asset": {
"id": "xyz789",
"type": "abc123",
"usdValue": "xyz789",
"content": Content,
"collateral": Collateral,
"addresses": [Address],
"action": Action
}
}
}
assets
Response
Arguments
Name
Description
Example
Query
Copy query Assets(
$where: AssetWhereInput,
$take: Int,
$skip: Int,
$gt: AssetWhereInput,
$lt: AssetWhereInput,
$like: AssetWhereInput,
$orderBy: [JSONObject]
) {
assets(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
type
usdValue
content {
...ContentFragment
}
collateral {
...CollateralFragment
}
addresses {
...AddressFragment
}
action {
...ActionFragment
}
}
count
}
}
Variables
Copy {
"where": AssetWhereInput,
"take": 123,
"skip": 123,
"gt": AssetWhereInput,
"lt": AssetWhereInput,
"like": AssetWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"assets": {"data": [Asset], "count": 123}}}
balance
Response
Arguments
Name
Description
Example
Query
Copy query Balance($where: AccountWhereInput) {
balance(where: $where) {
id
wallet
debit
credit
}
}
Variables
Copy {"where": AccountWhereInput}
Response
Copy {
"data": {
"balance": {
"id": "xyz789",
"wallet": "abc123",
"debit": "abc123",
"credit": "xyz789"
}
}
}
block
Response
Arguments
Name
Description
Example
Query
Copy query Block($where: BlockWhereInput) {
block(where: $where) {
id
indexed
}
}
Variables
Copy {"where": BlockWhereInput}
Response
Copy {
"data": {
"block": {
"id": "abc123",
"indexed": true
}
}
}
blocks
Response
Arguments
Name
Description
Example
Query
Copy query Blocks(
$where: BlockWhereInput,
$take: Int,
$skip: Int,
$gt: BlockWhereInput,
$lt: BlockWhereInput,
$like: BlockWhereInput,
$orderBy: [JSONObject]
) {
blocks(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
indexed
}
count
}
}
Variables
Copy {
"where": BlockWhereInput,
"take": 987,
"skip": 987,
"gt": BlockWhereInput,
"lt": BlockWhereInput,
"like": BlockWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"blocks": {"data": [Block], "count": 123}}}
collateral
Response
Arguments
Name
Description
Example
Query
Copy query Collateral($where: ActionWhereInput) {
collateral(where: $where) {
id
assets {
id
type
usdValue
content {
...ContentFragment
}
collateral {
...CollateralFragment
}
addresses {
...AddressFragment
}
action {
...ActionFragment
}
}
escrow {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
}
}
Variables
Copy {"where": ActionWhereInput}
Response
Copy {
"data": {
"collateral": {
"id": "xyz789",
"assets": [Asset],
"escrow": Escrow
}
}
}
collaterals
Response
Arguments
Name
Description
Example
Query
Copy query Collaterals(
$where: CollateralWhereInput,
$take: Int,
$skip: Int,
$gt: CollateralWhereInput,
$lt: ActionWhereInput,
$like: ActionWhereInput,
$orderBy: [JSONObject]
) {
collaterals(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
type
configuration
}
count
}
}
Variables
Copy {
"where": CollateralWhereInput,
"take": 987,
"skip": 123,
"gt": CollateralWhereInput,
"lt": ActionWhereInput,
"like": ActionWhereInput,
"orderBy": [{}]
}
Response
Copy {
"data": {
"collaterals": {"data": [Action], "count": 987}
}
}
element
Response
Arguments
Name
Description
Example
Query
Copy query Element($where: ElementWhereInput) {
element(where: $where) {
id
number
sequence
type
externalId
}
}
Variables
Copy {"where": ElementWhereInput}
Response
Copy {
"data": {
"element": {
"id": "abc123",
"number": "abc123",
"sequence": "xyz789",
"type": "abc123",
"externalId": "xyz789"
}
}
}
elements
Response
Arguments
Name
Description
Example
Query
Copy query Elements(
$where: ElementWhereInput,
$take: Int,
$skip: Int,
$gt: ElementWhereInput,
$lt: ElementWhereInput,
$like: ElementWhereInput,
$orderBy: [JSONObject]
) {
elements(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
number
sequence
type
externalId
}
count
}
}
Variables
Copy {
"where": ElementWhereInput,
"take": 987,
"skip": 123,
"gt": ElementWhereInput,
"lt": ElementWhereInput,
"like": ElementWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"elements": {"data": [Element], "count": 987}}}
escrow
Response
Arguments
Name
Description
Example
Query
Copy query Escrow($where: EscrowWhereInput) {
escrow(where: $where) {
id
startDate
endDate
status
collateral {
id
assets {
...AssetFragment
}
escrow {
...EscrowFragment
}
}
meta
transactions {
id
hex
type
base64
txid
inputs
outputs
}
sides {
id
movement
action
leaf
}
product {
id
name
type
key {
...KeyFragment
}
}
}
}
Variables
Copy {"where": EscrowWhereInput}
Response
Copy {
"data": {
"escrow": {
"id": "xyz789",
"startDate": "abc123",
"endDate": "xyz789",
"status": "abc123",
"collateral": Collateral,
"meta": {},
"transactions": [Transaction],
"sides": [Side],
"product": Product
}
}
}
escrows
Response
Arguments
Name
Description
Example
Query
Copy query Escrows(
$where: EscrowWhereInput,
$take: Int,
$skip: Int,
$gt: EscrowWhereInput,
$lt: EscrowWhereInput,
$like: EscrowWhereInput,
$orderBy: [JSONObject]
) {
escrows(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
count
}
}
Variables
Copy {
"where": EscrowWhereInput,
"take": 987,
"skip": 987,
"gt": EscrowWhereInput,
"lt": EscrowWhereInput,
"like": EscrowWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"escrows": {"data": [Escrow], "count": 987}}}
fee
Response
Arguments
Name
Description
Example
Query
Copy query Fee($where: FeeWhereInput) {
fee(where: $where) {
value
escrow {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
}
}
Variables
Copy {"where": FeeWhereInput}
Response
Copy {
"data": {
"fee": {
"value": "xyz789",
"escrow": Escrow
}
}
}
flow
Response
Arguments
Name
Description
Example
Query
Copy query Flow($where: FlowWhereInput) {
flow(where: $where) {
id
escrows {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
step
}
}
Variables
Copy {"where": FlowWhereInput}
Response
Copy {
"data": {
"flow": {
"id": "xyz789",
"escrows": [Escrow],
"step": {}
}
}
}
flows
Response
Arguments
Name
Description
Example
Query
Copy query Flows(
$where: FlowWhereInput,
$take: Int,
$skip: Int,
$gt: FlowWhereInput,
$lt: FlowWhereInput,
$like: FlowWhereInput,
$orderBy: [JSONObject]
) {
flows(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
escrows {
...EscrowFragment
}
step
}
count
}
}
Variables
Copy {
"where": FlowWhereInput,
"take": 123,
"skip": 123,
"gt": FlowWhereInput,
"lt": FlowWhereInput,
"like": FlowWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"flows": {"data": [Flow], "count": 123}}}
leg
Response
Arguments
Name
Description
Example
Query
Copy query Leg($where: LegWhereInput) {
leg(where: $where) {
id
startDate
endDate
type
nature
activationDate
address
value
}
}
Variables
Copy {"where": LegWhereInput}
Response
Copy {
"data": {
"leg": {
"id": "abc123",
"startDate": "abc123",
"endDate": "abc123",
"type": "abc123",
"nature": "abc123",
"activationDate": "abc123",
"address": "abc123",
"value": "xyz789"
}
}
}
legs
Response
Arguments
Name
Description
Example
Query
Copy query Legs(
$where: LegWhereInput,
$take: Int,
$skip: Int,
$gt: LegWhereInput,
$lt: LegWhereInput,
$like: LegWhereInput,
$orderBy: [JSONObject]
) {
legs(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
startDate
endDate
type
nature
activationDate
address
value
}
count
}
}
Variables
Copy {
"where": LegWhereInput,
"take": 123,
"skip": 987,
"gt": LegWhereInput,
"lt": LegWhereInput,
"like": LegWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"legs": {"data": [Leg], "count": 123}}}
outcome
Response
Arguments
Name
Description
Example
Query
Copy query Outcome($where: OutcomeWhereInput) {
outcome(where: $where) {
id
description
tag
conditions {
id
filter
module
outcome {
...OutcomeFragment
}
transaction {
...TransactionFragment
}
verification {
...VerificationFragment
}
}
signature {
publicKey
wif
}
block {
id
indexed
}
}
}
Variables
Copy {"where": OutcomeWhereInput}
Response
Copy {
"data": {
"outcome": {
"id": "xyz789",
"description": "abc123",
"tag": "abc123",
"conditions": [Condition],
"signature": Signature,
"block": Block
}
}
}
outcomes
Response
Arguments
Name
Description
Example
Query
Copy query Outcomes(
$where: OutcomeWhereInput,
$take: Int,
$skip: Int,
$gt: OutcomeWhereInput,
$lt: OutcomeWhereInput,
$like: OutcomeWhereInput,
$orderBy: [JSONObject]
) {
outcomes(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
description
tag
conditions {
...ConditionFragment
}
signature {
...SignatureFragment
}
block {
...BlockFragment
}
}
count
}
}
Variables
Copy {
"where": OutcomeWhereInput,
"take": 123,
"skip": 987,
"gt": OutcomeWhereInput,
"lt": OutcomeWhereInput,
"like": OutcomeWhereInput,
"orderBy": [{}]
}
Response
Copy {"data": {"outcomes": {"data": [Outcome], "count": 123}}}
transaction
Response
Arguments
Name
Description
Example
Query
Copy query Transaction($where: TransactionWhereInput) {
transaction(where: $where) {
id
hex
type
base64
txid
inputs
outputs
}
}
Variables
Copy {"where": TransactionWhereInput}
Response
Copy {
"data": {
"transaction": {
"id": "xyz789",
"hex": "xyz789",
"type": "abc123",
"base64": "xyz789",
"txid": "xyz789",
"inputs": 123,
"outputs": 123
}
}
}
transactions
Response
Arguments
Name
Description
Example
Query
Copy query Transactions(
$where: TransactionWhereInput,
$take: Int,
$skip: Int,
$gt: TransactionWhereInput,
$lt: TransactionWhereInput,
$like: TransactionWhereInput,
$orderBy: [JSONObject]
) {
transactions(
where: $where,
take: $take,
skip: $skip,
gt: $gt,
lt: $lt,
like: $like,
orderBy: $orderBy
) {
data {
id
hex
type
base64
txid
inputs
outputs
}
count
}
}
Variables
Copy {
"where": TransactionWhereInput,
"take": 987,
"skip": 987,
"gt": TransactionWhereInput,
"lt": TransactionWhereInput,
"like": TransactionWhereInput,
"orderBy": [{}]
}
Response
Copy {
"data": {
"transactions": {"data": [Transaction], "count": 987}
}
}
tvl
Response
Arguments
Name
Description
Example
Query
Copy query Tvl(
$where: LiquidityWhereInput,
$lt: LiquidityWhereInput
) {
tvl(
where: $where,
lt: $lt
) {
id
amount
escrow {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
organization {
id
name
logo
webhooks {
...WebhookFragment
}
}
}
}
Variables
Copy {
"where": LiquidityWhereInput,
"lt": LiquidityWhereInput
}
Response
Copy {
"data": {
"tvl": {
"id": 123,
"amount": "xyz789",
"escrow": Escrow,
"organization": Organization
}
}
}
Mutations
broadcastEscrow
Response
Arguments
Name
Description
Example
Query
Copy mutation BroadcastEscrow($data: EscrowDataInput) {
broadcastEscrow(data: $data) {
id
startDate
endDate
status
collateral {
id
assets {
...AssetFragment
}
escrow {
...EscrowFragment
}
}
meta
transactions {
id
hex
type
base64
txid
inputs
outputs
}
sides {
id
movement
action
leaf
}
product {
id
name
type
key {
...KeyFragment
}
}
}
}
Variables
Copy {"data": EscrowDataInput}
Response
Copy {
"data": {
"broadcastEscrow": {
"id": "xyz789",
"startDate": "xyz789",
"endDate": "xyz789",
"status": "abc123",
"collateral": Collateral,
"meta": {},
"transactions": [Transaction],
"sides": [Side],
"product": Product
}
}
}
buildSignature
Response
Arguments
Name
Description
Example
Query
Copy mutation BuildSignature($where: SignatureWhereInput) {
buildSignature(where: $where) {
publicKey
wif
}
}
Variables
Copy {"where": SignatureWhereInput}
Response
Copy {
"data": {
"buildSignature": {
"publicKey": "xyz789",
"wif": "xyz789"
}
}
}
checkOutcome
Response
Arguments
Name
Description
Example
Query
Copy mutation CheckOutcome($where: OutcomeWhereInput) {
checkOutcome(where: $where) {
id
description
tag
conditions {
id
filter
module
outcome {
...OutcomeFragment
}
transaction {
...TransactionFragment
}
verification {
...VerificationFragment
}
}
signature {
publicKey
wif
}
block {
id
indexed
}
}
}
Variables
Copy {"where": OutcomeWhereInput}
Response
Copy {
"data": {
"checkOutcome": {
"id": "xyz789",
"description": "xyz789",
"tag": "abc123",
"conditions": [Condition],
"signature": Signature,
"block": Block
}
}
}
createAddress
Response
Arguments
Name
Description
Example
Query
Copy mutation CreateAddress($data: AddressDataInput) {
createAddress(data: $data) {
id
value
publicKey
type
meta
escrow {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
}
}
Variables
Copy {"data": AddressDataInput}
Response
Copy {
"data": {
"createAddress": {
"id": "xyz789",
"value": "abc123",
"publicKey": "abc123",
"type": "abc123",
"meta": {},
"escrow": Escrow
}
}
}
createAsset
Response
Arguments
Name
Description
Example
Query
Copy mutation CreateAsset($data: AssetDataInput) {
createAsset(data: $data) {
id
type
usdValue
content {
meta
node
}
collateral {
id
assets {
...AssetFragment
}
escrow {
...EscrowFragment
}
}
addresses {
id
value
publicKey
type
meta
escrow {
...EscrowFragment
}
}
action {
id
type
configuration
}
}
}
Variables
Copy {"data": AssetDataInput}
Response
Copy {
"data": {
"createAsset": {
"id": "abc123",
"type": "abc123",
"usdValue": "abc123",
"content": Content,
"collateral": Collateral,
"addresses": [Address],
"action": Action
}
}
}
createCollateral
Response
Arguments
Name
Description
Example
Query
Copy mutation CreateCollateral($data: CollateralDataInput) {
createCollateral(data: $data) {
id
assets {
id
type
usdValue
content {
...ContentFragment
}
collateral {
...CollateralFragment
}
addresses {
...AddressFragment
}
action {
...ActionFragment
}
}
escrow {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
}
}
Variables
Copy {"data": CollateralDataInput}
Response
Copy {
"data": {
"createCollateral": {
"id": "abc123",
"assets": [Asset],
"escrow": Escrow
}
}
}
createElement
Response
Arguments
Name
Description
Example
Query
Copy mutation CreateElement($data: ElementDataInput) {
createElement(data: $data) {
id
number
sequence
type
externalId
}
}
Variables
Copy {"data": ElementDataInput}
Response
Copy {
"data": {
"createElement": {
"id": "abc123",
"number": "xyz789",
"sequence": "xyz789",
"type": "xyz789",
"externalId": "abc123"
}
}
}
createEscrow
Response
Arguments
Name
Description
Example
Query
Copy mutation CreateEscrow($data: EscrowDataInput) {
createEscrow(data: $data) {
id
startDate
endDate
status
collateral {
id
assets {
...AssetFragment
}
escrow {
...EscrowFragment
}
}
meta
transactions {
id
hex
type
base64
txid
inputs
outputs
}
sides {
id
movement
action
leaf
}
product {
id
name
type
key {
...KeyFragment
}
}
}
}
Variables
Copy {"data": EscrowDataInput}
Response
Copy {
"data": {
"createEscrow": {
"id": "xyz789",
"startDate": "abc123",
"endDate": "abc123",
"status": "abc123",
"collateral": Collateral,
"meta": {},
"transactions": [Transaction],
"sides": [Side],
"product": Product
}
}
}
createOutcome
Response
Arguments
Name
Description
Example
Query
Copy mutation CreateOutcome($data: OutcomeDataInput) {
createOutcome(data: $data) {
id
description
tag
conditions {
id
filter
module
outcome {
...OutcomeFragment
}
transaction {
...TransactionFragment
}
verification {
...VerificationFragment
}
}
signature {
publicKey
wif
}
block {
id
indexed
}
}
}
Variables
Copy {"data": OutcomeDataInput}
Response
Copy {
"data": {
"createOutcome": {
"id": "abc123",
"description": "abc123",
"tag": "abc123",
"conditions": [Condition],
"signature": Signature,
"block": Block
}
}
}
executeAction
Response
Arguments
Name
Description
Example
Query
Copy mutation ExecuteAction($where: ActionWhereInput) {
executeAction(where: $where) {
id
type
configuration
}
}
Variables
Copy {"where": ActionWhereInput}
Response
Copy {
"data": {
"executeAction": {
"id": "xyz789",
"type": "abc123",
"configuration": {}
}
}
}
executeEscrow
Response
Arguments
Name
Description
Example
Query
Copy mutation ExecuteEscrow($where: EscrowWhereInput) {
executeEscrow(where: $where) {
id
startDate
endDate
status
collateral {
id
assets {
...AssetFragment
}
escrow {
...EscrowFragment
}
}
meta
transactions {
id
hex
type
base64
txid
inputs
outputs
}
sides {
id
movement
action
leaf
}
product {
id
name
type
key {
...KeyFragment
}
}
}
}
Variables
Copy {"where": EscrowWhereInput}
Response
Copy {
"data": {
"executeEscrow": {
"id": "xyz789",
"startDate": "abc123",
"endDate": "xyz789",
"status": "xyz789",
"collateral": Collateral,
"meta": {},
"transactions": [Transaction],
"sides": [Side],
"product": Product
}
}
}
executeFlow
Response
Arguments
Name
Description
Example
Query
Copy mutation ExecuteFlow(
$where: JSONObject,
$data: JSONObject
) {
executeFlow(
where: $where,
data: $data
) {
id
escrows {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
step
}
}
Variables
Copy {"where": {}, "data": {}}
Response
Copy {
"data": {
"executeFlow": {
"id": "abc123",
"escrows": [Escrow],
"step": {}
}
}
}
executeSignature
Response
Arguments
Name
Description
Example
Query
Copy mutation ExecuteSignature(
$where: SignatureWhereInput,
$data: SignatureDataInput
) {
executeSignature(
where: $where,
data: $data
) {
publicKey
wif
}
}
Variables
Copy {
"where": SignatureWhereInput,
"data": SignatureDataInput
}
Response
Copy {
"data": {
"executeSignature": {
"publicKey": "abc123",
"wif": "abc123"
}
}
}
sign
Response
Arguments
Name
Description
Example
Query
Copy mutation Sign($where: OutcomeWhereInput) {
sign(where: $where) {
id
description
tag
conditions {
id
filter
module
outcome {
...OutcomeFragment
}
transaction {
...TransactionFragment
}
verification {
...VerificationFragment
}
}
signature {
publicKey
wif
}
block {
id
indexed
}
}
}
Variables
Copy {"where": OutcomeWhereInput}
Response
Copy {
"data": {
"sign": {
"id": "xyz789",
"description": "xyz789",
"tag": "xyz789",
"conditions": [Condition],
"signature": Signature,
"block": Block
}
}
}
updateAddress
Response
Arguments
Name
Description
Example
Query
Copy mutation UpdateAddress(
$data: AddressDataInput,
$where: AddressWhereInput
) {
updateAddress(
data: $data,
where: $where
) {
id
value
publicKey
type
meta
escrow {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
}
}
Variables
Copy {
"data": AddressDataInput,
"where": AddressWhereInput
}
Response
Copy {
"data": {
"updateAddress": {
"id": "abc123",
"value": "abc123",
"publicKey": "abc123",
"type": "abc123",
"meta": {},
"escrow": Escrow
}
}
}
updateAsset
Response
Arguments
Name
Description
Example
Query
Copy mutation UpdateAsset(
$data: AssetDataInput,
$where: AssetWhereInput
) {
updateAsset(
data: $data,
where: $where
) {
id
type
usdValue
content {
meta
node
}
collateral {
id
assets {
...AssetFragment
}
escrow {
...EscrowFragment
}
}
addresses {
id
value
publicKey
type
meta
escrow {
...EscrowFragment
}
}
action {
id
type
configuration
}
}
}
Variables
Copy {
"data": AssetDataInput,
"where": AssetWhereInput
}
Response
Copy {
"data": {
"updateAsset": {
"id": "xyz789",
"type": "xyz789",
"usdValue": "abc123",
"content": Content,
"collateral": Collateral,
"addresses": [Address],
"action": Action
}
}
}
updateCollateral
Response
Arguments
Name
Description
Example
Query
Copy mutation UpdateCollateral(
$where: CollateralWhereInput,
$data: CollateralDataInput
) {
updateCollateral(
where: $where,
data: $data
) {
id
assets {
id
type
usdValue
content {
...ContentFragment
}
collateral {
...CollateralFragment
}
addresses {
...AddressFragment
}
action {
...ActionFragment
}
}
escrow {
id
startDate
endDate
status
collateral {
...CollateralFragment
}
meta
transactions {
...TransactionFragment
}
sides {
...SideFragment
}
product {
...ProductFragment
}
}
}
}
Variables
Copy {
"where": CollateralWhereInput,
"data": CollateralDataInput
}
Response
Copy {
"data": {
"updateCollateral": {
"id": "xyz789",
"assets": [Asset],
"escrow": Escrow
}
}
}
updateElement
Response
Arguments
Name
Description
Example
Query
Copy mutation UpdateElement(
$where: ElementWhereInput,
$data: ElementDataInput
) {
updateElement(
where: $where,
data: $data
) {
id
number
sequence
type
externalId
}
}
Variables
Copy {
"where": ElementWhereInput,
"data": ElementDataInput
}
Response
Copy {
"data": {
"updateElement": {
"id": "abc123",
"number": "abc123",
"sequence": "abc123",
"type": "abc123",
"externalId": "xyz789"
}
}
}
updateTransaction
Response
Arguments
Name
Description
Example
Query
Copy mutation UpdateTransaction(
$where: TransactionWhereInput,
$data: TransactionDataInput
) {
updateTransaction(
where: $where,
data: $data
) {
id
hex
type
base64
txid
inputs
outputs
}
}
Variables
Copy {
"where": TransactionWhereInput,
"data": TransactionDataInput
}
Response
Copy {
"data": {
"updateTransaction": {
"id": "abc123",
"hex": "xyz789",
"type": "abc123",
"base64": "abc123",
"txid": "abc123",
"inputs": 123,
"outputs": 987
}
}
}
Subscriptions
balanceUpdated
Response
Arguments
Name
Description
Example
Query
Copy subscription BalanceUpdated($where: AccountWhereInput) {
balanceUpdated(where: $where) {
id
wallet
debit
credit
}
}
Variables
Copy {"where": AccountWhereInput}
Response
Copy {
"data": {
"balanceUpdated": {
"id": "abc123",
"wallet": "abc123",
"debit": "xyz789",
"credit": "xyz789"
}
}
}
Types
Account
Fields
Field Name
Description
Example
Copy {
"id": "abc123",
"wallet": "abc123",
"debit": "abc123",
"credit": "abc123"
}
Fields
Input Field
Description
Example
Copy {
"id": "xyz789",
"wallet": "xyz789"
}
Action
Fields
Field Name
Description
Example
Copy {
"id": "abc123",
"type": "xyz789",
"configuration": {}
}
Fields
Input Field
Description
Example
Copy {
"id": "xyz789",
"type": "xyz789",
"configuration": {}
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"type": "abc123",
"configuration": {}
}
Actions
Fields
Field Name
Description
Example
Copy {"data": [Action], "count": 987}
Address
Fields
Field Name
Description
Example
Copy {
"id": "abc123",
"value": "abc123",
"publicKey": "abc123",
"type": "xyz789",
"meta": {},
"escrow": Escrow
}
Fields
Input Field
Description
Example
Copy {
"id": "xyz789",
"value": "xyz789",
"publicKey": "abc123",
"type": "xyz789",
"meta": {},
"escrow": EscrowDataInput
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"value": "xyz789",
"publicKey": "abc123",
"type": "xyz789",
"meta": {},
"escrow": EscrowWhereInput
}
Addresses
Fields
Field Name
Description
Example
Copy {"data": [Address], "count": 123}
Asset
Fields
Field Name
Description
Example
Copy {
"id": "xyz789",
"type": "xyz789",
"usdValue": "abc123",
"content": Content,
"collateral": Collateral,
"addresses": [Address],
"action": Action
}
Fields
Input Field
Description
Example
Copy {
"id": "xyz789",
"type": "abc123",
"usdValue": "abc123",
"content": ContentDataInput,
"collateral": CollateralDataInput,
"addresses": [AddressDataInput],
"action": ActionDataInput
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"type": "xyz789",
"usdValue": "abc123",
"content": ContentWhereInput,
"collateral": CollateralWhereInput,
"addresses": [AddressWhereInput],
"action": ActionWhereInput
}
Assets
Fields
Field Name
Description
Example
Copy {"data": [Asset], "count": 123}
Block
Fields
Field Name
Description
Example
Copy {"id": "abc123", "indexed": true}
Fields
Input Field
Description
Example
Copy {"id": "xyz789", "indexed": false}
Blocks
Fields
Field Name
Description
Example
Copy {"data": [Block], "count": 123}
Boolean
Description
The Boolean
scalar type represents true
or false
.
Example
Collateral
Fields
Field Name
Description
Example
Copy {
"id": "xyz789",
"assets": [Asset],
"escrow": Escrow
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"assets": [AssetDataInput],
"escrow": EscrowDataInput
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"assets": [AssetWhereInput],
"escrow": EscrowWhereInput
}
Condition
Fields
Field Name
Description
Example
Copy {
"id": "4",
"filter": {},
"module": "xyz789",
"outcome": Outcome,
"transaction": Transaction,
"verification": Verification
}
Fields
Input Field
Description
Example
Copy {
"id": "4",
"filter": {},
"module": "abc123",
"outcome": OutcomeWhereInput,
"transaction": TransactionDataInput,
"verification": VerificationDataInput
}
Fields
Input Field
Description
Example
Copy {
"id": "4",
"filter": {},
"module": "xyz789",
"outcome": OutcomeWhereInput,
"verification": VerificationWhereInput
}
Content
Fields
Field Name
Description
Example
Copy {"meta": {}, "node": {}}
ContentDataInput
Fields
Input Field
Description
Example
Copy {"meta": {}, "node": {}}
ContentWhereInput
Fields
Input Field
Description
Example
Copy {"meta": {}, "node": {}}
Element
Fields
Field Name
Description
Example
Copy {
"id": "abc123",
"number": "xyz789",
"sequence": "xyz789",
"type": "abc123",
"externalId": "abc123"
}
Fields
Input Field
Description
Example
Copy {
"number": "xyz789",
"sequence": "abc123",
"type": "xyz789",
"externalId": "abc123"
}
Fields
Input Field
Description
Example
Copy {
"number": "abc123",
"sequence": "xyz789",
"type": "xyz789",
"externalId": "abc123"
}
Elements
Fields
Field Name
Description
Example
Copy {"data": [Element], "count": 987}
Escrow
Fields
Field Name
Description
Example
Copy {
"id": "abc123",
"startDate": "xyz789",
"endDate": "abc123",
"status": "xyz789",
"collateral": Collateral,
"meta": {},
"transactions": [Transaction],
"sides": [Side],
"product": Product
}
Fields
Input Field
Description
Example
Copy {
"id": "xyz789",
"startDate": "abc123",
"endDate": "xyz789",
"status": "xyz789",
"meta": {},
"collateral": CollateralDataInput,
"transactions": [TransactionDataInput],
"product": ProductDataInput
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"startDate": "abc123",
"endDate": "abc123",
"status": "abc123",
"collateral": CollateralWhereInput,
"transactions": [TransactionWhereInput],
"organization": OrganizationWhereInput,
"product": ProductWhereInput
}
Escrows
Fields
Field Name
Description
Example
Copy {"data": [Escrow], "count": 987}
Fee
Fields
Field Name
Description
Example
Copy {
"value": "abc123",
"escrow": Escrow
}
Fields
Input Field
Description
Example
Copy {
"value": "abc123",
"escrow": EscrowWhereInput
}
Flow
Fields
Field Name
Description
Example
Copy {
"id": "xyz789",
"escrows": [Escrow],
"step": {}
}
Fields
Input Field
Description
Example
Flows
Fields
Field Name
Description
Example
Copy {"data": [Flow], "count": 987}
ID
Description
The ID
scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4"
) or integer (such as 4
) input value will be accepted as an ID.
Example
Int
Description
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
JSONObject
Example
Leg
Fields
Field Name
Description
Example
Copy {
"id": "xyz789",
"startDate": "abc123",
"endDate": "xyz789",
"type": "abc123",
"nature": "abc123",
"activationDate": "abc123",
"address": "xyz789",
"value": "abc123"
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"startDate": "abc123",
"endDate": "xyz789",
"type": "abc123",
"nature": "abc123",
"activationDate": "xyz789",
"address": "xyz789",
"value": "abc123"
}
Legs
Fields
Field Name
Description
Example
Copy {"data": [Leg], "count": 987}
Liquidity
Fields
Field Name
Description
Example
Copy {
"id": 123,
"amount": "xyz789",
"escrow": Escrow,
"organization": Organization
}
Fields
Input Field
Description
Example
Copy {
"id": 987,
"amount": "abc123",
"escrow": EscrowWhereInput,
"organization": OrganizationWhereInput
}
Outcome
Fields
Field Name
Description
Example
Copy {
"id": "abc123",
"description": "xyz789",
"tag": "abc123",
"conditions": [Condition],
"signature": Signature,
"block": Block
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"description": "abc123",
"tag": "xyz789",
"conditions": [ConditionDataInput],
"OR": [OutcomeDataInput]
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"description": "xyz789",
"tag": "xyz789",
"conditions": [ConditionWhereInput],
"block": BlockWhereInput,
"signature": SignatureWhereInput,
"OR": [OutcomeWhereInput]
}
Outcomes
Fields
Field Name
Description
Example
Copy {"data": [Outcome], "count": 123}
Side
Fields
Field Name
Description
Example
Copy {
"id": "xyz789",
"movement": "xyz789",
"action": "xyz789",
"leaf": "xyz789"
}
Signature
Fields
Field Name
Description
Example
Copy {
"publicKey": "abc123",
"wif": "abc123"
}
Fields
Input Field
Description
Example
Copy {
"publicKey": "abc123",
"wif": "abc123",
"transactions": [TransactionDataInput],
"escrow": {}
}
Fields
Input Field
Description
Example
Copy {
"publicKey": "abc123",
"wif": "xyz789",
"OR": [SignatureWhereInput],
"escrow": {}
}
String
Description
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
Transaction
Fields
Field Name
Description
Example
Copy {
"id": "abc123",
"hex": "abc123",
"type": "xyz789",
"base64": "abc123",
"txid": "abc123",
"inputs": 987,
"outputs": 987
}
Fields
Input Field
Description
Example
Copy {
"id": "abc123",
"hex": "xyz789",
"type": "xyz789",
"base64": "abc123",
"txid": "abc123",
"inputs": 123,
"outputs": 123
}
Fields
Input Field
Description
Example
Copy {
"id": "xyz789",
"hex": "xyz789",
"type": "abc123",
"base64": "abc123",
"txid": "xyz789",
"inputs": 123,
"outputs": 987
}
Transactions
Fields
Field Name
Description
Example
Copy {"data": [Transaction], "count": 123}
Verification
Fields
Field Name
Description
Example
Copy {
"id": 4,
"leftOperand": {},
"rightOperand": {},
"operation": "abc123",
"condition": Condition
}
Fields
Input Field
Description
Example
Copy {
"id": 4,
"leftOperand": {},
"rightOperand": {},
"operation": "abc123",
"condition": ConditionDataInput
}
Fields
Input Field
Description
Example
Copy {
"id": "4",
"leftOperand": {},
"rightOperand": {},
"operation": "abc123",
"condition": ConditionWhereInput
}
Fields
Field Name
Description
Example
Copy {"data": [Webhook], "count": 123}