API Reference
Queries
action
actionResponse
Returns an Action
Arguments
Name
Description
where - ActionWhereInput
Example
Query
query Action($where: ActionWhereInput) {
action(where: $where) {
id
type
configuration
}
}Variables
Response
actions
actionsResponse
Returns an Actions
Arguments
Name
Description
where - ActionWhereInput
take - Int
skip - Int
gt - ActionWhereInput
lt - ActionWhereInput
like - ActionWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
address
addressResponse
Returns an Address
Arguments
Name
Description
where - AddressWhereInput
Example
Query
Variables
Response
addresses
addressesResponse
Returns an Addresses
Arguments
Name
Description
where - AddressWhereInput
take - Int
skip - Int
gt - AddressWhereInput
lt - AddressWhereInput
like - AddressWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
asset
assetResponse
Returns an Asset
Arguments
Name
Description
where - AssetWhereInput
Example
Query
Variables
Response
assets
assetsResponse
Returns an Assets
Arguments
Name
Description
where - AssetWhereInput
take - Int
skip - Int
gt - AssetWhereInput
lt - AssetWhereInput
like - AssetWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
balance
balanceResponse
Returns an Account
Arguments
Name
Description
where - AccountWhereInput
Example
Query
Variables
Response
block
blockResponse
Returns a Block
Arguments
Name
Description
where - BlockWhereInput
Example
Query
Variables
Response
blocks
blocksResponse
Returns a Blocks
Arguments
Name
Description
where - BlockWhereInput
take - Int
skip - Int
gt - BlockWhereInput
lt - BlockWhereInput
like - BlockWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
collateral
collateralResponse
Returns a Collateral
Arguments
Name
Description
where - ActionWhereInput
Example
Query
Variables
Response
collaterals
collateralsResponse
Returns an Actions
Arguments
Name
Description
where - CollateralWhereInput
take - Int
skip - Int
gt - CollateralWhereInput
lt - ActionWhereInput
like - ActionWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
element
elementResponse
Returns an Element
Arguments
Name
Description
where - ElementWhereInput
Example
Query
Variables
Response
elements
elementsResponse
Returns an Elements
Arguments
Name
Description
where - ElementWhereInput
take - Int
skip - Int
gt - ElementWhereInput
lt - ElementWhereInput
like - ElementWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
escrow
escrowResponse
Returns an Escrow
Arguments
Name
Description
where - EscrowWhereInput
Example
Query
Variables
Response
escrows
escrowsResponse
Returns an Escrows
Arguments
Name
Description
where - EscrowWhereInput
take - Int
skip - Int
gt - EscrowWhereInput
lt - EscrowWhereInput
like - EscrowWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
fee
feeResponse
Returns a Fee
Arguments
Name
Description
where - FeeWhereInput
Example
Query
Variables
Response
flow
flowResponse
Returns a Flow
Arguments
Name
Description
where - FlowWhereInput
Example
Query
Variables
Response
flows
flowsResponse
Returns a Flows
Arguments
Name
Description
where - FlowWhereInput
take - Int
skip - Int
gt - FlowWhereInput
lt - FlowWhereInput
like - FlowWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
leg
legResponse
Returns a Leg
Arguments
Name
Description
where - LegWhereInput
Example
Query
Variables
Response
legs
legsResponse
Returns a Legs
Arguments
Name
Description
where - LegWhereInput
take - Int
skip - Int
gt - LegWhereInput
lt - LegWhereInput
like - LegWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
outcome
outcomeResponse
Returns an Outcome
Arguments
Name
Description
where - OutcomeWhereInput
Example
Query
Variables
Response
outcomes
outcomesResponse
Returns an Outcomes
Arguments
Name
Description
where - OutcomeWhereInput
take - Int
skip - Int
gt - OutcomeWhereInput
lt - OutcomeWhereInput
like - OutcomeWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
transaction
transactionResponse
Returns a Transaction
Arguments
Name
Description
where - TransactionWhereInput
Example
Query
Variables
Response
transactions
transactionsResponse
Returns a Transactions
Arguments
Name
Description
where - TransactionWhereInput
take - Int
skip - Int
like - TransactionWhereInput
orderBy - [JSONObject]
Example
Query
Variables
Response
tvl
tvlResponse
Returns a Liquidity
Arguments
Name
Description
where - LiquidityWhereInput
lt - LiquidityWhereInput
Example
Query
Variables
Response
Mutations
broadcastEscrow
broadcastEscrowResponse
Returns an Escrow
Arguments
Name
Description
data - EscrowDataInput
Example
Query
Variables
Response
buildSignature
buildSignatureResponse
Returns a Signature
Arguments
Name
Description
where - SignatureWhereInput
Example
Query
Variables
Response
checkOutcome
checkOutcomeResponse
Returns an Outcome
Arguments
Name
Description
where - OutcomeWhereInput
Example
Query
Variables
Response
createAddress
createAddressResponse
Returns an Address
Arguments
Name
Description
data - AddressDataInput
Example
Query
Variables
Response
createAsset
createAssetResponse
Returns an Asset
Arguments
Name
Description
data - AssetDataInput
Example
Query
Variables
Response
createCollateral
createCollateralResponse
Returns a Collateral
Arguments
Name
Description
data - CollateralDataInput
Example
Query
Variables
Response
createElement
createElementResponse
Returns an Element
Arguments
Name
Description
data - ElementDataInput
Example
Query
Variables
Response
createEscrow
createEscrowResponse
Returns an Escrow
Arguments
Name
Description
data - EscrowDataInput
Example
Query
Variables
Response
createOutcome
createOutcomeResponse
Returns an Outcome
Arguments
Name
Description
data - OutcomeDataInput
Example
Query
Variables
Response
executeAction
executeActionResponse
Returns an Action
Arguments
Name
Description
where - ActionWhereInput
Example
Query
Variables
Response
executeEscrow
executeEscrowResponse
Returns an Escrow
Arguments
Name
Description
where - EscrowWhereInput
Example
Query
Variables
Response
executeFlow
executeFlowResponse
Returns a Flow
Arguments
Name
Description
where - JSONObject
data - JSONObject
Example
Query
Variables
Response
executeSignature
executeSignatureResponse
Returns a Signature
Arguments
Name
Description
where - SignatureWhereInput
data - SignatureDataInput
Example
Query
Variables
Response
sign
signResponse
Returns an Outcome
Arguments
Name
Description
where - OutcomeWhereInput
Example
Query
Variables
Response
updateAddress
updateAddressResponse
Returns an Address
Arguments
Name
Description
data - AddressDataInput
where - AddressWhereInput
Example
Query
Variables
Response
updateAsset
updateAssetResponse
Returns an Asset
Arguments
Name
Description
data - AssetDataInput
where - AssetWhereInput
Example
Query
Variables
Response
updateCollateral
updateCollateralResponse
Returns a Collateral
Arguments
Name
Description
where - CollateralWhereInput
data - CollateralDataInput
Example
Query
Variables
Response
updateElement
updateElementResponse
Returns an Element
Arguments
Name
Description
where - ElementWhereInput
data - ElementDataInput
Example
Query
Variables
Response
updateTransaction
updateTransactionResponse
Returns a Transaction
Arguments
Name
Description
where - TransactionWhereInput
data - TransactionDataInput
Example
Query
Variables
Response
Subscriptions
balanceUpdated
balanceUpdatedResponse
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
AccountWhereInput
Fields
Input Field
Description
id - String
wallet - String
Example
Action
Fields
Field Name
Description
id - String!
type - String
configuration - JSONObject
Example
ActionDataInput
Fields
Input Field
Description
id - String
type - String
configuration - JSONObject
Example
ActionWhereInput
Fields
Input Field
Description
id - String
type - String
configuration - JSONObject
Example
Actions
Fields
Field Name
Description
data - [Action]
count - Int
Example
Address
Fields
Field Name
Description
id - String!
value - String
publicKey - String
type - String
meta - JSONObject
escrow - Escrow
Example
AddressDataInput
Fields
Input Field
Description
id - String
value - String
publicKey - String
type - String
meta - JSONObject
escrow - EscrowDataInput
Example
AddressWhereInput
Fields
Input Field
Description
id - String
value - String
publicKey - String
type - String
meta - JSONObject
escrow - EscrowWhereInput
Example
Addresses
Fields
Field Name
Description
data - [Address]
count - Int
Example
Asset
Fields
Field Name
Description
id - String!
type - String
usdValue - String
content - Content
collateral - Collateral
addresses - [Address]
action - Action
Example
AssetDataInput
Fields
Input Field
Description
id - String
type - String
usdValue - String
content - ContentDataInput
collateral - CollateralDataInput
addresses - [AddressDataInput]
action - ActionDataInput
Example
AssetWhereInput
Fields
Input Field
Description
id - String
type - String
usdValue - String
content - ContentWhereInput
collateral - CollateralWhereInput
addresses - [AddressWhereInput]
action - ActionWhereInput
Example
Assets
Fields
Field Name
Description
data - [Asset]
count - Int
Example
Block
Fields
Field Name
Description
id - String
indexed - Boolean
Example
BlockWhereInput
Fields
Input Field
Description
id - String
indexed - Boolean
Example
Blocks
Fields
Field Name
Description
data - [Block]
count - Int
Example
Boolean
Description
The Boolean scalar type represents true or false.
Example
Collateral
Fields
Field Name
Description
id - String!
assets - [Asset]
escrow - Escrow
Example
CollateralDataInput
Fields
Input Field
Description
id - String
assets - [AssetDataInput]
escrow - EscrowDataInput
Example
CollateralWhereInput
Fields
Input Field
Description
id - String
assets - [AssetWhereInput]
escrow - EscrowWhereInput
Example
Condition
Fields
Field Name
Description
id - ID
filter - JSONObject
module - String
outcome - Outcome
transaction - Transaction
verification - Verification
Example
ConditionDataInput
Fields
Input Field
Description
id - ID
filter - JSONObject
module - String
outcome - OutcomeWhereInput
transaction - TransactionDataInput
verification - VerificationDataInput
Example
ConditionWhereInput
Fields
Input Field
Description
id - ID
filter - JSONObject
module - String
outcome - OutcomeWhereInput
verification - VerificationWhereInput
Example
Content
Fields
Field Name
Description
meta - JSONObject
node - JSONObject
Example
ContentDataInput
Fields
Input Field
Description
meta - JSONObject
node - JSONObject
Example
ContentWhereInput
Fields
Input Field
Description
meta - JSONObject
node - JSONObject
Example
Element
Fields
Field Name
Description
id - String!
number - String
sequence - String
type - String
externalId - String
Example
ElementDataInput
Fields
Input Field
Description
number - String
sequence - String
type - String
externalId - String
Example
ElementWhereInput
Fields
Input Field
Description
number - String
sequence - String
type - String
externalId - String
Example
Elements
Fields
Field Name
Description
data - [Element]
count - Int
Example
Escrow
Fields
Field Name
Description
id - String!
startDate - String
endDate - String
status - String
collateral - Collateral
meta - JSONObject
transactions - [Transaction]
sides - [Side]
product - Product
Example
EscrowDataInput
Fields
Input Field
Description
id - String
startDate - String
endDate - String
status - String
meta - JSONObject
collateral - CollateralDataInput
transactions - [TransactionDataInput]
product - ProductDataInput
Example
EscrowWhereInput
Fields
Input Field
Description
id - String
startDate - String
endDate - String
status - String
collateral - CollateralWhereInput
transactions - [TransactionWhereInput]
organization - OrganizationWhereInput
product - ProductWhereInput
Example
Escrows
Fields
Field Name
Description
data - [Escrow]
count - Int
Example
Fee
Fields
Field Name
Description
value - String
escrow - Escrow
Example
FeeWhereInput
Fields
Input Field
Description
value - String
escrow - EscrowWhereInput
Example
Flow
Fields
Field Name
Description
id - String!
escrows - [Escrow]
step - JSONObject
Example
FlowWhereInput
Fields
Input Field
Description
id - String
Example
Flows
Fields
Field Name
Description
data - [Flow]
count - Int
Example
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
JSONObject
Example
Leg
Fields
Field Name
Description
id - String!
startDate - String
endDate - String
type - String
nature - String
activationDate - String
address - String
value - String
Example
LegWhereInput
Fields
Input Field
Description
id - String
startDate - String
endDate - String
type - String
nature - String
activationDate - String
address - String
value - String
Example
Legs
Fields
Field Name
Description
data - [Leg]
count - Int
Example
Liquidity
Fields
Field Name
Description
id - Int
amount - String
escrow - Escrow
organization - Organization
Example
LiquidityWhereInput
Fields
Input Field
Description
id - Int
amount - String
escrow - EscrowWhereInput
organization - OrganizationWhereInput
Example
Outcome
Fields
Field Name
Description
id - String
description - String
tag - String
conditions - [Condition]
signature - Signature
block - Block
Example
OutcomeDataInput
Fields
Input Field
Description
id - String
description - String
tag - String
conditions - [ConditionDataInput]
OR - [OutcomeDataInput]
Example
OutcomeWhereInput
Fields
Input Field
Description
id - String
description - String
tag - String
conditions - [ConditionWhereInput]
block - BlockWhereInput
signature - SignatureWhereInput
OR - [OutcomeWhereInput]
Example
Outcomes
Fields
Field Name
Description
data - [Outcome]
count - Int
Example
Side
Fields
Field Name
Description
id - String
movement - String
action - String
leaf - String
Example
Signature
Fields
Field Name
Description
publicKey - String
wif - String
Example
SignatureDataInput
Fields
Input Field
Description
publicKey - String
wif - String
transactions - [TransactionDataInput]
escrow - JSONObject
Example
SignatureWhereInput
Fields
Input Field
Description
publicKey - String
wif - String
escrow - JSONObject
Example
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
Transaction
Fields
Field Name
Description
id - String
hex - String
type - String
base64 - String
txid - String
inputs - Int
outputs - Int
Example
TransactionDataInput
Fields
Input Field
Description
id - String
hex - String
type - String
base64 - String
txid - String
inputs - Int
outputs - Int
Example
TransactionWhereInput
Fields
Input Field
Description
id - String
hex - String
type - String
base64 - String
txid - String
inputs - Int
outputs - Int
Example
Transactions
Fields
Field Name
Description
data - [Transaction]
count - Int
Example
Verification
Fields
Field Name
Description
id - ID
leftOperand - JSONObject
rightOperand - JSONObject
operation - String
condition - Condition
Example
VerificationDataInput
Fields
Input Field
Description
id - ID
leftOperand - JSONObject
rightOperand - JSONObject
operation - String
condition - ConditionDataInput
Example
VerificationWhereInput
Fields
Input Field
Description
id - ID
leftOperand - JSONObject
rightOperand - JSONObject
operation - String
condition - ConditionWhereInput
Example
Fields
Field Name
Description
data - [Webhook]
count - Int
Example
Last updated
Was this helpful?