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