Queries
action
Response
Returns an Action
Arguments
Name
Description
where - ActionWhereInput
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": {}
}
}
} Queries
actions
Response
Returns an Actions
Arguments
Name
Description
where - ActionWhereInput
take - Int
skip - Int
gt - ActionWhereInput
lt - ActionWhereInput
like - ActionWhereInput
orderBy - [JSONObject]
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}}} Queries
address
Response
Returns an Address
Arguments
Name
Description
where - AddressWhereInput
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
}
}
} Queries
addresses
Response
Returns an Addresses
Arguments
Name
Description
where - AddressWhereInput
take - Int
skip - Int
gt - AddressWhereInput
lt - AddressWhereInput
like - AddressWhereInput
orderBy - [JSONObject]
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}}} Queries
asset
Response
Returns an Asset
Arguments
Name
Description
where - AssetWhereInput
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
}
}
} Queries
assets
Response
Returns an Assets
Arguments
Name
Description
where - AssetWhereInput
take - Int
skip - Int
gt - AssetWhereInput
lt - AssetWhereInput
like - AssetWhereInput
orderBy - [JSONObject]
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}}} Queries
balance
Response
Returns an Account
Arguments
Name
Description
where - AccountWhereInput
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"
}
}
} Queries
block
Response
Returns a Block
Arguments
Name
Description
where - BlockWhereInput
Example
Query
Copy query Block($where: BlockWhereInput) {
block(where: $where) {
id
indexed
}
} Variables
Copy {"where": BlockWhereInput} Response
Copy {
"data": {
"block": {
"id": "abc123",
"indexed": true
}
}
} Queries
blocks
Response
Returns a Blocks
Arguments
Name
Description
where - BlockWhereInput
take - Int
skip - Int
gt - BlockWhereInput
lt - BlockWhereInput
like - BlockWhereInput
orderBy - [JSONObject]
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}}} Queries
collateral
Response
Returns a Collateral
Arguments
Name
Description
where - ActionWhereInput
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
}
}
} Queries
collaterals
Response
Returns an Actions
Arguments
Name
Description
where - CollateralWhereInput
take - Int
skip - Int
gt - CollateralWhereInput
lt - ActionWhereInput
like - ActionWhereInput
orderBy - [JSONObject]
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}
}
} Queries
element
Response
Returns an Element
Arguments
Name
Description
where - ElementWhereInput
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"
}
}
} Queries
elements
Response
Returns an Elements
Arguments
Name
Description
where - ElementWhereInput
take - Int
skip - Int
gt - ElementWhereInput
lt - ElementWhereInput
like - ElementWhereInput
orderBy - [JSONObject]
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}}} Queries
escrow
Response
Returns an Escrow
Arguments
Name
Description
where - EscrowWhereInput
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
}
}
} Queries
escrows
Response
Returns an Escrows
Arguments
Name
Description
where - EscrowWhereInput
take - Int
skip - Int
gt - EscrowWhereInput
lt - EscrowWhereInput
like - EscrowWhereInput
orderBy - [JSONObject]
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}}} Queries
fee
Response
Returns a Fee
Arguments
Name
Description
where - FeeWhereInput
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
}
}
} Queries
flow
Response
Returns a Flow
Arguments
Name
Description
where - FlowWhereInput
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": {}
}
}
} Queries
flows
Response
Returns a Flows
Arguments
Name
Description
where - FlowWhereInput
take - Int
skip - Int
gt - FlowWhereInput
lt - FlowWhereInput
like - FlowWhereInput
orderBy - [JSONObject]
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}}} Queries
leg
Response
Returns a Leg
Arguments
Name
Description
where - LegWhereInput
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"
}
}
} Queries
legs
Response
Returns a Legs
Arguments
Name
Description
where - LegWhereInput
take - Int
skip - Int
gt - LegWhereInput
lt - LegWhereInput
like - LegWhereInput
orderBy - [JSONObject]
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}}} Queries
outcome
Response
Returns an Outcome
Arguments
Name
Description
where - OutcomeWhereInput
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
}
}
} Queries
outcomes
Response
Returns an Outcomes
Arguments
Name
Description
where - OutcomeWhereInput
take - Int
skip - Int
gt - OutcomeWhereInput
lt - OutcomeWhereInput
like - OutcomeWhereInput
orderBy - [JSONObject]
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}}} Queries
transaction
Response
Returns a Transaction
Arguments
Name
Description
where - TransactionWhereInput
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
}
}
} Queries
transactions
Response
Returns a Transactions
Arguments
Name
Description
where - TransactionWhereInput
take - Int
skip - Int
gt - TransactionWhereInput
lt - TransactionWhereInput
like - TransactionWhereInput
orderBy - [JSONObject]
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}
}
} Queries
tvl
Response
Returns a Liquidity
Arguments
Name
Description
where - LiquidityWhereInput
lt - LiquidityWhereInput
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
}
}
} Queries
Mutations
Mutations
broadcastEscrow
Response
Returns an Escrow
Arguments
Name
Description
data - EscrowDataInput
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
}
}
} Mutations
buildSignature
Response
Returns a Signature
Arguments
Name
Description
where - SignatureWhereInput
Example
Query
Copy mutation BuildSignature($where: SignatureWhereInput) {
buildSignature(where: $where) {
publicKey
wif
}
} Variables
Copy {"where": SignatureWhereInput} Response
Copy {
"data": {
"buildSignature": {
"publicKey": "xyz789",
"wif": "xyz789"
}
}
} Mutations
checkOutcome
Response
Returns an Outcome
Arguments
Name
Description
where - OutcomeWhereInput
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
}
}
} Mutations
createAddress
Response
Returns an Address
Arguments
Name
Description
data - AddressDataInput
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
}
}
} Mutations
createAsset
Response
Returns an Asset
Arguments
Name
Description
data - AssetDataInput
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
}
}
} Mutations
createCollateral
Response
Returns a Collateral
Arguments
Name
Description
data - CollateralDataInput
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
}
}
} Mutations
createElement
Response
Returns an Element
Arguments
Name
Description
data - ElementDataInput
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"
}
}
} Mutations
createEscrow
Response
Returns an Escrow
Arguments
Name
Description
data - EscrowDataInput
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
}
}
} Mutations
createOutcome
Response
Returns an Outcome
Arguments
Name
Description
data - OutcomeDataInput
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
}
}
} Mutations
executeAction
Response
Returns an Action
Arguments
Name
Description
where - ActionWhereInput
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": {}
}
}
} Mutations
executeEscrow
Response
Returns an Escrow
Arguments
Name
Description
where - EscrowWhereInput
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
}
}
} Mutations
executeFlow
Response
Returns a Flow
Arguments
Name
Description
where - JSONObject
data - JSONObject
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": {}
}
}
} Mutations
executeSignature
Response
Returns a Signature
Arguments
Name
Description
where - SignatureWhereInput
data - SignatureDataInput
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"
}
}
} Mutations
sign
Response
Returns an Outcome
Arguments
Name
Description
where - OutcomeWhereInput
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
}
}
} Mutations
updateAddress
Response
Returns an Address
Arguments
Name
Description
data - AddressDataInput
where - AddressWhereInput
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
}
}
} Mutations
updateAsset
Response
Returns an Asset
Arguments
Name
Description
data - AssetDataInput
where - AssetWhereInput
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
}
}
} Mutations
updateCollateral
Response
Returns a Collateral
Arguments
Name
Description
where - CollateralWhereInput
data - CollateralDataInput
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
}
}
} Mutations
updateElement
Response
Returns an Element
Arguments
Name
Description
where - ElementWhereInput
data - ElementDataInput
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"
}
}
} Mutations
updateTransaction
Response
Returns a Transaction
Arguments
Name
Description
where - TransactionWhereInput
data - TransactionDataInput
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
}
}
} Mutations
Subscriptions
balanceUpdated
Response
Returns an Account
Arguments
Name
Description
where - AccountWhereInput
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
id - String!
wallet - String
debit - String
credit - String
Example
Copy {
"id": "abc123",
"wallet": "abc123",
"debit": "abc123",
"credit": "abc123"
} Types
AccountWhereInput
Fields
Input Field
Description
id - String
wallet - String
Example
Copy {
"id": "xyz789",
"wallet": "xyz789"
} Types
Action
Fields
Field Name
Description
id - String!
type - String
configuration - JSONObject
Example
Copy {
"id": "abc123",
"type": "xyz789",
"configuration": {}
} Types
ActionDataInput
Fields
Input Field
Description
id - String
type - String
configuration - JSONObject
Example
Copy {
"id": "xyz789",
"type": "xyz789",
"configuration": {}
} Types
ActionWhereInput
Fields
Input Field
Description
id - String
type - String
configuration - JSONObject
Example
Copy {
"id": "abc123",
"type": "abc123",
"configuration": {}
} Types
Actions
Fields
Field Name
Description
data - [Action]
count - Int
Example
Copy {"data": [Action], "count": 987} Types
Address
Fields
Field Name
Description
id - String!
value - String
publicKey - String
type - String
meta - JSONObject
escrow - Escrow
Example
Copy {
"id": "abc123",
"value": "abc123",
"publicKey": "abc123",
"type": "xyz789",
"meta": {},
"escrow": Escrow
} Types
AddressDataInput
Fields
Input Field
Description
id - String
value - String
publicKey - String
type - String
meta - JSONObject
escrow - EscrowDataInput
Example
Copy {
"id": "xyz789",
"value": "xyz789",
"publicKey": "abc123",
"type": "xyz789",
"meta": {},
"escrow": EscrowDataInput
} Types
AddressWhereInput
Fields
Input Field
Description
id - String
value - String
publicKey - String
type - String
meta - JSONObject
escrow - EscrowWhereInput
Example
Copy {
"id": "abc123",
"value": "xyz789",
"publicKey": "abc123",
"type": "xyz789",
"meta": {},
"escrow": EscrowWhereInput
} Types
Addresses
Fields
Field Name
Description
data - [Address]
count - Int
Example
Copy {"data": [Address], "count": 123} Types
Asset
Fields
Field Name
Description
id - String!
type - String
usdValue - String
content - Content
collateral - Collateral
addresses - [Address]
action - Action
Example
Copy {
"id": "xyz789",
"type": "xyz789",
"usdValue": "abc123",
"content": Content,
"collateral": Collateral,
"addresses": [Address],
"action": Action
} Types
AssetDataInput
Fields
Input Field
Description
id - String
type - String
usdValue - String
content - ContentDataInput
collateral - CollateralDataInput
addresses - [AddressDataInput]
action - ActionDataInput
Example
Copy {
"id": "xyz789",
"type": "abc123",
"usdValue": "abc123",
"content": ContentDataInput,
"collateral": CollateralDataInput,
"addresses": [AddressDataInput],
"action": ActionDataInput
} Types
AssetWhereInput
Fields
Input Field
Description
id - String
type - String
usdValue - String
content - ContentWhereInput
collateral - CollateralWhereInput
addresses - [AddressWhereInput]
action - ActionWhereInput
Example
Copy {
"id": "abc123",
"type": "xyz789",
"usdValue": "abc123",
"content": ContentWhereInput,
"collateral": CollateralWhereInput,
"addresses": [AddressWhereInput],
"action": ActionWhereInput
} Types
Assets
Fields
Field Name
Description
data - [Asset]
count - Int
Example
Copy {"data": [Asset], "count": 123} Types
Block
Fields
Field Name
Description
id - String
indexed - Boolean
Example
Copy {"id": "abc123", "indexed": true} Types
BlockWhereInput
Fields
Input Field
Description
id - String
indexed - Boolean
Example
Copy {"id": "xyz789", "indexed": false} Types
Blocks
Fields
Field Name
Description
data - [Block]
count - Int
Example
Copy {"data": [Block], "count": 123} Types
Boolean
Description
The Boolean scalar type represents true or false.
Example
Types
Collateral
Fields
Field Name
Description
id - String!
assets - [Asset]
escrow - Escrow
Example
Copy {
"id": "xyz789",
"assets": [Asset],
"escrow": Escrow
} Types
CollateralDataInput
Fields
Input Field
Description
id - String
assets - [AssetDataInput]
escrow - EscrowDataInput
Example
Copy {
"id": "abc123",
"assets": [AssetDataInput],
"escrow": EscrowDataInput
} Types
CollateralWhereInput
Fields
Input Field
Description
id - String
assets - [AssetWhereInput]
escrow - EscrowWhereInput
Example
Copy {
"id": "abc123",
"assets": [AssetWhereInput],
"escrow": EscrowWhereInput
} Types
Condition
Fields
Field Name
Description
id - ID
filter - JSONObject
module - String
outcome - Outcome
transaction - Transaction
verification - Verification
Example
Copy {
"id": "4",
"filter": {},
"module": "xyz789",
"outcome": Outcome,
"transaction": Transaction,
"verification": Verification
} Types
ConditionDataInput
Fields
Input Field
Description
id - ID
filter - JSONObject
module - String
outcome - OutcomeWhereInput
transaction - TransactionDataInput
verification - VerificationDataInput
Example
Copy {
"id": "4",
"filter": {},
"module": "abc123",
"outcome": OutcomeWhereInput,
"transaction": TransactionDataInput,
"verification": VerificationDataInput
} Types
ConditionWhereInput
Fields
Input Field
Description
id - ID
filter - JSONObject
module - String
outcome - OutcomeWhereInput
verification - VerificationWhereInput
Example
Copy {
"id": "4",
"filter": {},
"module": "xyz789",
"outcome": OutcomeWhereInput,
"verification": VerificationWhereInput
} Types
Content
Fields
Field Name
Description
meta - JSONObject
node - JSONObject
Example
Copy {"meta": {}, "node": {}} Types
ContentDataInput
Fields
Input Field
Description
meta - JSONObject
node - JSONObject
Example
Copy {"meta": {}, "node": {}} Types
ContentWhereInput
Fields
Input Field
Description
meta - JSONObject
node - JSONObject
Example
Copy {"meta": {}, "node": {}} Types
Element
Fields
Field Name
Description
id - String!
number - String
sequence - String
type - String
externalId - String
Example
Copy {
"id": "abc123",
"number": "xyz789",
"sequence": "xyz789",
"type": "abc123",
"externalId": "abc123"
} Types
ElementDataInput
Fields
Input Field
Description
number - String
sequence - String
type - String
externalId - String
Example
Copy {
"number": "xyz789",
"sequence": "abc123",
"type": "xyz789",
"externalId": "abc123"
} Types
ElementWhereInput
Fields
Input Field
Description
number - String
sequence - String
type - String
externalId - String
Example
Copy {
"number": "abc123",
"sequence": "xyz789",
"type": "xyz789",
"externalId": "abc123"
} Types
Elements
Fields
Field Name
Description
data - [Element]
count - Int
Example
Copy {"data": [Element], "count": 987} Types
Escrow
Fields
Field Name
Description
id - String!
startDate - String
endDate - String
status - String
collateral - Collateral
meta - JSONObject
transactions - [Transaction]
sides - [Side]
product - Product
Example
Copy {
"id": "abc123",
"startDate": "xyz789",
"endDate": "abc123",
"status": "xyz789",
"collateral": Collateral,
"meta": {},
"transactions": [Transaction],
"sides": [Side],
"product": Product
} Types
EscrowDataInput
Fields
Input Field
Description
id - String
startDate - String
endDate - String
status - String
meta - JSONObject
collateral - CollateralDataInput
transactions - [TransactionDataInput]
product - ProductDataInput
Example
Copy {
"id": "xyz789",
"startDate": "abc123",
"endDate": "xyz789",
"status": "xyz789",
"meta": {},
"collateral": CollateralDataInput,
"transactions": [TransactionDataInput],
"product": ProductDataInput
} Types
EscrowWhereInput
Fields
Input Field
Description
id - String
startDate - String
endDate - String
status - String
collateral - CollateralWhereInput
transactions - [TransactionWhereInput]
organization - OrganizationWhereInput
product - ProductWhereInput
Example
Copy {
"id": "abc123",
"startDate": "abc123",
"endDate": "abc123",
"status": "abc123",
"collateral": CollateralWhereInput,
"transactions": [TransactionWhereInput],
"organization": OrganizationWhereInput,
"product": ProductWhereInput
} Types
Escrows
Fields
Field Name
Description
data - [Escrow]
count - Int
Example
Copy {"data": [Escrow], "count": 987} Types
Fee
Fields
Field Name
Description
value - String
escrow - Escrow
Example
Copy {
"value": "abc123",
"escrow": Escrow
} Types
FeeWhereInput
Fields
Input Field
Description
value - String
escrow - EscrowWhereInput
Example
Copy {
"value": "abc123",
"escrow": EscrowWhereInput
} Types
Flow
Fields
Field Name
Description
id - String!
escrows - [Escrow]
step - JSONObject
Example
Copy {
"id": "xyz789",
"escrows": [Escrow],
"step": {}
} Types
FlowWhereInput
Fields
Input Field
Description
id - String
Example
Types
Flows
Fields
Field Name
Description
data - [Flow]
count - Int
Example
Copy {"data": [Flow], "count": 987} Types
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
Types
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
Types
JSONObject
Example
Types
Leg
Fields
Field Name
Description
id - String!
startDate - String
endDate - String
type - String
nature - String
activationDate - String
address - String
value - String
Example
Copy {
"id": "xyz789",
"startDate": "abc123",
"endDate": "xyz789",
"type": "abc123",
"nature": "abc123",
"activationDate": "abc123",
"address": "xyz789",
"value": "abc123"
} Types
LegWhereInput
Fields
Input Field
Description
id - String
startDate - String
endDate - String
type - String
nature - String
activationDate - String
address - String
value - String
Example
Copy {
"id": "abc123",
"startDate": "abc123",
"endDate": "xyz789",
"type": "abc123",
"nature": "abc123",
"activationDate": "xyz789",
"address": "xyz789",
"value": "abc123"
} Types
Legs
Fields
Field Name
Description
data - [Leg]
count - Int
Example
Copy {"data": [Leg], "count": 987} Types
Liquidity
Fields
Field Name
Description
id - Int
amount - String
escrow - Escrow
organization - Organization
Example
Copy {
"id": 123,
"amount": "xyz789",
"escrow": Escrow,
"organization": Organization
} Types
LiquidityWhereInput
Fields
Input Field
Description
id - Int
amount - String
escrow - EscrowWhereInput
organization - OrganizationWhereInput
Example
Copy {
"id": 987,
"amount": "abc123",
"escrow": EscrowWhereInput,
"organization": OrganizationWhereInput
} Types
Outcome
Fields
Field Name
Description
id - String
description - String
tag - String
conditions - [Condition]
signature - Signature
block - Block
Example
Copy {
"id": "abc123",
"description": "xyz789",
"tag": "abc123",
"conditions": [Condition],
"signature": Signature,
"block": Block
} Types
OutcomeDataInput
Fields
Input Field
Description
id - String
description - String
tag - String
conditions - [ConditionDataInput]
OR - [OutcomeDataInput]
Example
Copy {
"id": "abc123",
"description": "abc123",
"tag": "xyz789",
"conditions": [ConditionDataInput],
"OR": [OutcomeDataInput]
} Types
OutcomeWhereInput
Fields
Input Field
Description
id - String
description - String
tag - String
conditions - [ConditionWhereInput]
block - BlockWhereInput
signature - SignatureWhereInput
OR - [OutcomeWhereInput]
Example
Copy {
"id": "abc123",
"description": "xyz789",
"tag": "xyz789",
"conditions": [ConditionWhereInput],
"block": BlockWhereInput,
"signature": SignatureWhereInput,
"OR": [OutcomeWhereInput]
} Types
Outcomes
Fields
Field Name
Description
data - [Outcome]
count - Int
Example
Copy {"data": [Outcome], "count": 123} Types
Side
Fields
Field Name
Description
id - String
movement - String
action - String
leaf - String
Example
Copy {
"id": "xyz789",
"movement": "xyz789",
"action": "xyz789",
"leaf": "xyz789"
} Types
Signature
Fields
Field Name
Description
publicKey - String
wif - String
Example
Copy {
"publicKey": "abc123",
"wif": "abc123"
} Types
SignatureDataInput
Fields
Input Field
Description
publicKey - String
wif - String
transactions - [TransactionDataInput]
escrow - JSONObject
Example
Copy {
"publicKey": "abc123",
"wif": "abc123",
"transactions": [TransactionDataInput],
"escrow": {}
} Types
SignatureWhereInput
Fields
Input Field
Description
publicKey - String
wif - String
OR - [SignatureWhereInput]
escrow - JSONObject
Example
Copy {
"publicKey": "abc123",
"wif": "xyz789",
"OR": [SignatureWhereInput],
"escrow": {}
} Types
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
Types
Transaction
Fields
Field Name
Description
id - String
hex - String
type - String
base64 - String
txid - String
inputs - Int
outputs - Int
Example
Copy {
"id": "abc123",
"hex": "abc123",
"type": "xyz789",
"base64": "abc123",
"txid": "abc123",
"inputs": 987,
"outputs": 987
} Types
TransactionDataInput
Fields
Input Field
Description
id - String
hex - String
type - String
base64 - String
txid - String
inputs - Int
outputs - Int
Example
Copy {
"id": "abc123",
"hex": "xyz789",
"type": "xyz789",
"base64": "abc123",
"txid": "abc123",
"inputs": 123,
"outputs": 123
} Types
TransactionWhereInput
Fields
Input Field
Description
id - String
hex - String
type - String
base64 - String
txid - String
inputs - Int
outputs - Int
Example
Copy {
"id": "xyz789",
"hex": "xyz789",
"type": "abc123",
"base64": "abc123",
"txid": "xyz789",
"inputs": 123,
"outputs": 987
} Types
Transactions
Fields
Field Name
Description
data - [Transaction]
count - Int
Example
Copy {"data": [Transaction], "count": 123} Types
Verification
Fields
Field Name
Description
id - ID
leftOperand - JSONObject
rightOperand - JSONObject
operation - String
condition - Condition
Example
Copy {
"id": 4,
"leftOperand": {},
"rightOperand": {},
"operation": "abc123",
"condition": Condition
} Types
VerificationDataInput
Fields
Input Field
Description
id - ID
leftOperand - JSONObject
rightOperand - JSONObject
operation - String
condition - ConditionDataInput
Example
Copy {
"id": 4,
"leftOperand": {},
"rightOperand": {},
"operation": "abc123",
"condition": ConditionDataInput
} Types
VerificationWhereInput
Fields
Input Field
Description
id - ID
leftOperand - JSONObject
rightOperand - JSONObject
operation - String
condition - ConditionWhereInput
Example
Copy {
"id": "4",
"leftOperand": {},
"rightOperand": {},
"operation": "abc123",
"condition": ConditionWhereInput
} Types
Fields
Field Name
Description
data - [Webhook]
count - Int
Example
Copy {"data": [Webhook], "count": 123} 