API Reference

Queries

action

Response

Returns an Action

Arguments

Name

Description

where - ActionWhereInput

Example

Query

query Action($where: ActionWhereInput) {
  action(where: $where) {
    id
    type
    configuration
  }
}

Variables

Response

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

Variables

Response

Queries

address

Response

Returns an Address

Arguments

Name

Description

where - AddressWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

asset

Response

Returns an Asset

Arguments

Name

Description

where - AssetWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

balance

Response

Returns an Account

Arguments

Name

Description

where - AccountWhereInput

Example

Query

Variables

Response

Queries

block

Response

Returns a Block

Arguments

Name

Description

where - BlockWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

collateral

Response

Returns a Collateral

Arguments

Name

Description

where - ActionWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

element

Response

Returns an Element

Arguments

Name

Description

where - ElementWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

escrow

Response

Returns an Escrow

Arguments

Name

Description

where - EscrowWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

fee

Response

Returns a Fee

Arguments

Name

Description

where - FeeWhereInput

Example

Query

Variables

Response

Queries

flow

Response

Returns a Flow

Arguments

Name

Description

where - FlowWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

leg

Response

Returns a Leg

Arguments

Name

Description

where - LegWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

outcome

Response

Returns an Outcome

Arguments

Name

Description

where - OutcomeWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

transaction

Response

Returns a Transaction

Arguments

Name

Description

where - TransactionWhereInput

Example

Query

Variables

Response

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

Variables

Response

Queries

tvl

Response

Returns a Liquidity

Arguments

Name

Description

where - LiquidityWhereInput

lt - LiquidityWhereInput

Example

Query

Variables

Response

Queries

Mutations

Mutations

broadcastEscrow

Response

Returns an Escrow

Arguments

Name

Description

data - EscrowDataInput

Example

Query

Variables

Response

Mutations

buildSignature

Response

Returns a Signature

Arguments

Name

Description

where - SignatureWhereInput

Example

Query

Variables

Response

Mutations

checkOutcome

Response

Returns an Outcome

Arguments

Name

Description

where - OutcomeWhereInput

Example

Query

Variables

Response

Mutations

createAddress

Response

Returns an Address

Arguments

Name

Description

data - AddressDataInput

Example

Query

Variables

Response

Mutations

createAsset

Response

Returns an Asset

Arguments

Name

Description

data - AssetDataInput

Example

Query

Variables

Response

Mutations

createCollateral

Response

Returns a Collateral

Arguments

Name

Description

data - CollateralDataInput

Example

Query

Variables

Response

Mutations

createElement

Response

Returns an Element

Arguments

Name

Description

data - ElementDataInput

Example

Query

Variables

Response

Mutations

createEscrow

Response

Returns an Escrow

Arguments

Name

Description

data - EscrowDataInput

Example

Query

Variables

Response

Mutations

createOutcome

Response

Returns an Outcome

Arguments

Name

Description

data - OutcomeDataInput

Example

Query

Variables

Response

Mutations

executeAction

Response

Returns an Action

Arguments

Name

Description

where - ActionWhereInput

Example

Query

Variables

Response

Mutations

executeEscrow

Response

Returns an Escrow

Arguments

Name

Description

where - EscrowWhereInput

Example

Query

Variables

Response

Mutations

executeFlow

Response

Returns a Flow

Arguments

Name

Description

where - JSONObject

data - JSONObject

Example

Query

Variables

Response

Mutations

executeSignature

Response

Returns a Signature

Arguments

Name

Description

where - SignatureWhereInput

data - SignatureDataInput

Example

Query

Variables

Response

Mutations

sign

Response

Returns an Outcome

Arguments

Name

Description

where - OutcomeWhereInput

Example

Query

Variables

Response

Mutations

updateAddress

Response

Returns an Address

Arguments

Name

Description

data - AddressDataInput

where - AddressWhereInput

Example

Query

Variables

Response

Mutations

updateAsset

Response

Returns an Asset

Arguments

Name

Description

data - AssetDataInput

where - AssetWhereInput

Example

Query

Variables

Response

Mutations

updateCollateral

Response

Returns a Collateral

Arguments

Name

Description

where - CollateralWhereInput

data - CollateralDataInput

Example

Query

Variables

Response

Mutations

updateElement

Response

Returns an Element

Arguments

Name

Description

where - ElementWhereInput

data - ElementDataInput

Example

Query

Variables

Response

Mutations

updateTransaction

Response

Returns a Transaction

Arguments

Name

Description

where - TransactionWhereInput

data - TransactionDataInput

Example

Query

Variables

Response

Mutations

Subscriptions

balanceUpdated

Response

Returns an Account

Arguments

Name

Description

where - AccountWhereInput

Example

Query

Variables

Response

Types

Account

Fields

Field Name

Description

id - String!

wallet - String

debit - String

credit - String

Example

Types

AccountWhereInput

Fields

Input Field

Description

id - String

wallet - String

Example

Types

Action

Fields

Field Name

Description

id - String!

type - String

configuration - JSONObject

Example

Types

ActionDataInput

Fields

Input Field

Description

id - String

type - String

configuration - JSONObject

Example

Types

ActionWhereInput

Fields

Input Field

Description

id - String

type - String

configuration - JSONObject

Example

Types

Actions

Fields

Field Name

Description

data - [Action]

count - Int

Example

Types

Address

Fields

Field Name

Description

id - String!

value - String

publicKey - String

type - String

meta - JSONObject

escrow - Escrow

Example

Types

AddressDataInput

Fields

Input Field

Description

id - String

value - String

publicKey - String

type - String

meta - JSONObject

escrow - EscrowDataInput

Example

Types

AddressWhereInput

Fields

Input Field

Description

id - String

value - String

publicKey - String

type - String

meta - JSONObject

escrow - EscrowWhereInput

Example

Types

Addresses

Fields

Field Name

Description

data - [Address]

count - Int

Example

Types

Asset

Fields

Field Name

Description

id - String!

type - String

usdValue - String

content - Content

collateral - Collateral

addresses - [Address]

action - Action

Example

Types

AssetDataInput

Fields

Input Field

Description

id - String

type - String

usdValue - String

content - ContentDataInput

collateral - CollateralDataInput

addresses - [AddressDataInput]

action - ActionDataInput

Example

Types

AssetWhereInput

Fields

Input Field

Description

id - String

type - String

usdValue - String

content - ContentWhereInput

collateral - CollateralWhereInput

addresses - [AddressWhereInput]

action - ActionWhereInput

Example

Types

Assets

Fields

Field Name

Description

data - [Asset]

count - Int

Example

Types

Block

Fields

Field Name

Description

id - String

indexed - Boolean

Example

Types

BlockWhereInput

Fields

Input Field

Description

id - String

indexed - Boolean

Example

Types

Blocks

Fields

Field Name

Description

data - [Block]

count - Int

Example

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

Types

CollateralDataInput

Fields

Input Field

Description

id - String

assets - [AssetDataInput]

escrow - EscrowDataInput

Example

Types

CollateralWhereInput

Fields

Input Field

Description

id - String

assets - [AssetWhereInput]

escrow - EscrowWhereInput

Example

Types

Condition

Fields

Field Name

Description

id - ID

filter - JSONObject

module - String

outcome - Outcome

transaction - Transaction

verification - Verification

Example

Types

ConditionDataInput

Fields

Input Field

Description

id - ID

filter - JSONObject

module - String

outcome - OutcomeWhereInput

transaction - TransactionDataInput

verification - VerificationDataInput

Example

Types

ConditionWhereInput

Fields

Input Field

Description

id - ID

filter - JSONObject

module - String

outcome - OutcomeWhereInput

verification - VerificationWhereInput

Example

Types

Content

Fields

Field Name

Description

meta - JSONObject

node - JSONObject

Example

Types

ContentDataInput

Fields

Input Field

Description

meta - JSONObject

node - JSONObject

Example

Types

ContentWhereInput

Fields

Input Field

Description

meta - JSONObject

node - JSONObject

Example

Types

Element

Fields

Field Name

Description

id - String!

number - String

sequence - String

type - String

externalId - String

Example

Types

ElementDataInput

Fields

Input Field

Description

number - String

sequence - String

type - String

externalId - String

Example

Types

ElementWhereInput

Fields

Input Field

Description

number - String

sequence - String

type - String

externalId - String

Example

Types

Elements

Fields

Field Name

Description

data - [Element]

count - Int

Example

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

Types

EscrowDataInput

Fields

Input Field

Description

id - String

startDate - String

endDate - String

status - String

meta - JSONObject

collateral - CollateralDataInput

transactions - [TransactionDataInput]

product - ProductDataInput

Example

Types

EscrowWhereInput

Fields

Input Field

Description

id - String

startDate - String

endDate - String

status - String

collateral - CollateralWhereInput

transactions - [TransactionWhereInput]

organization - OrganizationWhereInput

product - ProductWhereInput

Example

Types

Escrows

Fields

Field Name

Description

data - [Escrow]

count - Int

Example

Types

Fee

Fields

Field Name

Description

value - String

escrow - Escrow

Example

Types

FeeWhereInput

Fields

Input Field

Description

value - String

escrow - EscrowWhereInput

Example

Types

Flow

Fields

Field Name

Description

id - String!

escrows - [Escrow]

step - JSONObject

Example

Types

FlowWhereInput

Fields

Input Field

Description

id - String

Example

Types

Flows

Fields

Field Name

Description

data - [Flow]

count - Int

Example

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

Types

LegWhereInput

Fields

Input Field

Description

id - String

startDate - String

endDate - String

type - String

nature - String

activationDate - String

address - String

value - String

Example

Types

Legs

Fields

Field Name

Description

data - [Leg]

count - Int

Example

Types

Liquidity

Fields

Field Name

Description

id - Int

amount - String

escrow - Escrow

organization - Organization

Example

Types

LiquidityWhereInput

Fields

Input Field

Description

id - Int

amount - String

escrow - EscrowWhereInput

organization - OrganizationWhereInput

Example

Types

Outcome

Fields

Field Name

Description

id - String

description - String

tag - String

conditions - [Condition]

signature - Signature

block - Block

Example

Types

OutcomeDataInput

Fields

Input Field

Description

id - String

description - String

tag - String

conditions - [ConditionDataInput]

OR - [OutcomeDataInput]

Example

Types

OutcomeWhereInput

Fields

Input Field

Description

id - String

description - String

tag - String

conditions - [ConditionWhereInput]

block - BlockWhereInput

signature - SignatureWhereInput

OR - [OutcomeWhereInput]

Example

Types

Outcomes

Fields

Field Name

Description

data - [Outcome]

count - Int

Example

Types

Side

Fields

Field Name

Description

id - String

movement - String

action - String

leaf - String

Example

Types

Signature

Fields

Field Name

Description

publicKey - String

wif - String

Example

Types

SignatureDataInput

Fields

Input Field

Description

publicKey - String

wif - String

transactions - [TransactionDataInput]

escrow - JSONObject

Example

Types

SignatureWhereInput

Fields

Input Field

Description

publicKey - String

wif - String

OR - [SignatureWhereInput]

escrow - JSONObject

Example

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

Types

TransactionDataInput

Fields

Input Field

Description

id - String

hex - String

type - String

base64 - String

txid - String

inputs - Int

outputs - Int

Example

Types

TransactionWhereInput

Fields

Input Field

Description

id - String

hex - String

type - String

base64 - String

txid - String

inputs - Int

outputs - Int

Example

Types

Transactions

Fields

Field Name

Description

data - [Transaction]

count - Int

Example

Types

Verification

Fields

Field Name

Description

id - ID

leftOperand - JSONObject

rightOperand - JSONObject

operation - String

condition - Condition

Example

Types

VerificationDataInput

Fields

Input Field

Description

id - ID

leftOperand - JSONObject

rightOperand - JSONObject

operation - String

condition - ConditionDataInput

Example

Types

VerificationWhereInput

Fields

Input Field

Description

id - ID

leftOperand - JSONObject

rightOperand - JSONObject

operation - String

condition - ConditionWhereInput

Example

Types


Fields

Field Name

Description

data - [Webhook]

count - Int

Example

Last updated

Was this helpful?