Read Peer protocol, market, checkout, and Peer Cash data through one MCP server.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Read the current USDC balance for an address.
ERC20 token address.
Optional raw JSON params merged beneath typed fields.
Wallet address.
Read the current USDC balance for an address.
| Argument | Type | Description |
|---|---|---|
| token | string | ERC20 token address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| address | string | Wallet address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"token": {
"type": "string",
"description": "ERC20 token address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"address": {
"type": "string",
"description": "Wallet address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Return protocol history for the buyer that matched an order so an automation can assess delivery context without trusting display identity.
| Argument | Type | Description |
|---|---|---|
| address* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"pattern": "^0x[a-fA-F0-9]{40}$"
}
}
}Return live Base USDC destinations, payout platforms, fiat currencies, payee hints, amount bounds, and pricing. Call this before naming a rail or currency.
| Argument | Type | Description |
|---|---|---|
| includeRelaySources | boolean | Include live Relay-supported EVM source chains and tokens |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"includeRelaySources": {
"type": "boolean",
"description": "Include live Relay-supported EVM source chains and tokens"
}
}
}Estimate fiat received for Base USDC at the live Chainlink oracle rate. This is not a locked quote; the binding rate resolves when a buyer fills.
| Argument | Type | Description |
|---|---|---|
| amount* | string | Base USDC amount in 6-decimal base units |
| currency* | string | Fiat currency from capabilities |
| platform | string | Optional payout platform for corridor fill timing |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^[1-9]\\d*$",
"description": "Base USDC amount in 6-decimal base units"
},
"currency": {
"type": "string",
"minLength": 3,
"description": "Fiat currency from capabilities"
},
"platform": {
"type": "string",
"minLength": 1,
"description": "Optional payout platform for corridor fill timing"
}
}
}Return trailing 30-day fill counts and first-fill timing by payout platform and currency. Use this as historical routing evidence, never as a guarantee.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Read a confirmed Base createDeposit receipt and resolve the resumable Peer deposit id. Call only after the host confirms the createDeposit transaction.
| Argument | Type | Description |
|---|---|---|
| transactionHash* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"transactionHash"
],
"properties": {
"transactionHash": {
"type": "string",
"pattern": "^0x[a-fA-F0-9]{64}$"
}
}
}Return one order state, amounts, fills, and next actions from its deposit id. Brief ORDER_NOT_FOUND responses after finalization may be indexer lag; retry this read, never the deposit transaction.
| Argument | Type | Description |
|---|---|---|
| depositId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depositId"
],
"properties": {
"depositId": {
"type": "string",
"pattern": "^0x[a-fA-F0-9]{40}_[0-9]+$"
}
}
}List orders owned by a maker wallet, optionally limited to orders that still need attention.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| owner* | string | |
| inFlight | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"owner"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1
},
"owner": {
"type": "string",
"pattern": "^0x[a-fA-F0-9]{40}$"
},
"inFlight": {
"type": "boolean"
}
}
}Quote a live Relay route from an EVM source asset into Base USDC. The response contains unsigned transaction data; this tool never signs or submits it.
| Argument | Type | Description |
|---|---|---|
| user* | string | Source-chain wallet address |
| amount* | string | Source amount in the source token’s base units |
| recipient | string | Base recipient; defaults to the source wallet |
| tradeType | string | Relay amount mode; defaults to EXACT_INPUT |
| sourceChainId* | integer | Relay source chain ID |
| sourceCurrency* | string | Source token address or native currency identifier |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user",
"amount",
"sourceChainId",
"sourceCurrency"
],
"properties": {
"user": {
"type": "string",
"pattern": "^0x[a-fA-F0-9]{40}$",
"description": "Source-chain wallet address"
},
"amount": {
"type": "string",
"pattern": "^[1-9]\\d*$",
"description": "Source amount in the source token’s base units"
},
"recipient": {
"type": "string",
"pattern": "^0x[a-fA-F0-9]{40}$",
"description": "Base recipient; defaults to the source wallet"
},
"tradeType": {
"enum": [
"EXACT_INPUT",
"EXACT_OUTPUT",
"EXPECTED_OUTPUT"
],
"type": "string",
"description": "Relay amount mode; defaults to EXACT_INPUT"
},
"sourceChainId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Relay source chain ID",
"exclusiveMinimum": 0
},
"sourceCurrency": {
"type": "string",
"minLength": 1,
"description": "Source token address or native currency identifier"
}
}
}Track a previously submitted cross-chain source route by Relay request ID. Retry this read; never resubmit from an unknown status.
| Argument | Type | Description |
|---|---|---|
| requestId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string",
"minLength": 1
}
}
}Return live Relay-supported EVM source chains and tokens that can route into Base USDC before a Peer Cash order.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List checkout sessions from the Pay API, with a local cache fallback.
| Argument | Type | Description |
|---|---|---|
| page | number | Page number. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| status | string | Status filter. |
| pageSize | number | Page size. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "number",
"default": 1,
"description": "Page number."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"status": {
"type": "string",
"description": "Status filter."
},
"pageSize": {
"type": "number",
"default": 25,
"description": "Page size."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Show a single checkout session or poll its latest status.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| sessionId* | string | Session identifier. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sessionId"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"sessionId": {
"type": "string",
"description": "Session identifier."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List supported fiat currencies.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List supported payment platforms.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Show the stored Peer CLI config merged with current global flags.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Show current controller-based delegation for a deposit.
| Argument | Type | Description |
|---|---|---|
| escrow | string | Escrow address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| deposit | string | Deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"escrow": {
"type": "string",
"description": "Escrow address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"deposit": {
"type": "string",
"description": "Deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List deposits owned by the configured wallet or explicit owner.
| Argument | Type | Description |
|---|---|---|
| owner | string | Owner address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"owner": {
"type": "string",
"description": "Owner address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Show a single deposit by deposit ID.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositId* | string | Deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depositId"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Show multiple deposits by ID.
| Argument | Type | Description |
|---|---|---|
| ids | string | Deposit IDs. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"ids": {
"type": "string",
"description": "Deposit IDs."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Check whether the selected environment has an IntentGuardian deployment.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read payer token balance and allowance available to IntentGuardian.
| Argument | Type | Description |
|---|---|---|
| payer* | string | Payer address. |
| token* | string | Deposit token address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"payer",
"token"
],
"properties": {
"payer": {
"type": "string",
"description": "Payer address."
},
"token": {
"type": "string",
"description": "Deposit token address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read the live IntentGuardian fee and extension policy.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Quote the authoritative on-chain cost to extend an intent.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| intentAmount* | string | Intent token amount in base units. |
| additionalSeconds* | string | Extension seconds. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"intentAmount",
"additionalSeconds"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"intentAmount": {
"type": "string",
"description": "Intent token amount in base units."
},
"additionalSeconds": {
"type": "string",
"description": "Extension seconds."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch the delegation record for a composite deposit ID via the indexer.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| options | object | Delegation query options. |
| depositId* | string | Composite deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depositId"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"options": {
"type": "object",
"description": "Delegation query options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Composite deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Fetch multiple deposits by composite ID.
| Argument | Type | Description |
|---|---|---|
| ids | string | Composite IDs. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"ids": {
"type": "string",
"description": "Composite IDs."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch multiple deposits with relations by composite ID.
| Argument | Type | Description |
|---|---|---|
| ids | string | Composite IDs. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| options | object | Relation options. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"ids": {
"type": "string",
"description": "Composite IDs."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"options": {
"type": "object",
"description": "Relation options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Fetch fund activities for a deposit.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositId* | string | Composite deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depositId"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Composite deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List deposits via the indexer.
| Argument | Type | Description |
|---|---|---|
| filter | object | Filter object. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| pagination | object | Pagination object. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"filter": {
"type": "object",
"description": "Filter object.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema2"
}
},
"pagination": {
"type": "object",
"description": "Pagination object.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
},
"__schema2": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema2"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema2"
}
}
]
}
}
}List deposits with related entities via the indexer.
| Argument | Type | Description |
|---|---|---|
| filter | object | Filter object. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| options | object | Relation options. |
| pagination | object | Pagination object. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"filter": {
"type": "object",
"description": "Filter object.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema3"
}
},
"options": {
"type": "object",
"description": "Relation options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema2"
}
},
"pagination": {
"type": "object",
"description": "Pagination object.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
},
"__schema2": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema2"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema2"
}
}
]
},
"__schema3": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema3"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema3"
}
}
]
}
}
}Fetch a deposit by composite ID via the indexer.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| options | object | Relation options. |
| compositeId* | string | Composite ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"compositeId"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"options": {
"type": "object",
"description": "Relation options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"compositeId": {
"type": "string",
"description": "Composite ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Fetch deposit daily snapshots.
| Argument | Type | Description |
|---|---|---|
| limit | number | Snapshot limit. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositId* | string | Composite deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depositId"
],
"properties": {
"limit": {
"type": "number",
"description": "Snapshot limit."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Composite deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch intents for multiple deposits via the indexer.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| statuses | array | Intent statuses. |
| depositIds | array | Deposit IDs. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema2"
}
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
},
"description": "Intent statuses."
},
"depositIds": {
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
},
"description": "Deposit IDs."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
},
"__schema2": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema2"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema2"
}
}
]
}
}
}Fetch intents by owner via the indexer.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Owner address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| statuses | array | Intent statuses. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"owner"
],
"properties": {
"owner": {
"type": "string",
"description": "Owner address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
},
"description": "Intent statuses."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Fetch expired intents via the indexer.
| Argument | Type | Description |
|---|---|---|
| now | string | Current time. |
| limit | number | Result limit. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositIds | array | Deposit IDs. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"now": {
"type": "string",
"description": "Current time."
},
"limit": {
"type": "number",
"description": "Result limit."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"depositIds": {
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
},
"description": "Deposit IDs."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Fetch fulfillment events for intents.
| Argument | Type | Description |
|---|---|---|
| hashes | array | Intent hashes. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"hashes": {
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
},
"description": "Intent hashes."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Fetch fulfillment amounts for an intent.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| intentHash* | string | Intent hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"intentHash"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"intentHash": {
"type": "string",
"description": "Intent hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch fulfillment and payment records for an intent.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| intentHash* | string | Intent hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"intentHash"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"intentHash": {
"type": "string",
"description": "Intent hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch a single intent via the indexer.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| intentHash* | string | Intent hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"intentHash"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"intentHash": {
"type": "string",
"description": "Intent hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch maker-level fund activities.
| Argument | Type | Description |
|---|---|---|
| limit | number | Activity limit. |
| maker* | string | Maker address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"maker"
],
"properties": {
"limit": {
"type": "number",
"description": "Activity limit."
},
"maker": {
"type": "string",
"description": "Maker address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Perform a raw GraphQL query against the indexer. Use sparingly; arbitrary queries can be expensive.
| Argument | Type | Description |
|---|---|---|
| query | string | GraphQL query. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| variables | object | GraphQL variables. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"query": {
"type": "string",
"description": "GraphQL query."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"variables": {
"type": "object",
"description": "GraphQL variables.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Inspect fulfill routing inputs for an intent.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| intentHash* | string | Intent hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"intentHash"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"intentHash": {
"type": "string",
"description": "Intent hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Get the pre-intent hook for a deposit.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositId* | string | Deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depositId"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List intents for the configured wallet or explicit owner.
| Argument | Type | Description |
|---|---|---|
| owner | string | Owner address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"owner": {
"type": "string",
"description": "Owner address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Show a single intent by hash.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| intentHash* | string | Intent hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"intentHash"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"intentHash": {
"type": "string",
"description": "Intent hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch recent protocol activity from Peerlytics.
| Argument | Type | Description |
|---|---|---|
| type | string | Event types. |
| limit | number | Result limit. |
| since | string | Start timestamp. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"type": {
"type": "string",
"description": "Event types."
},
"limit": {
"type": "number",
"default": 100,
"description": "Result limit."
},
"since": {
"type": "string",
"description": "Start timestamp."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List Peerlytics API keys for the authenticated account.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Compare live quote availability across platforms using the published SDK quote route.
| Argument | Type | Description |
|---|---|---|
| from | string | Fiat currency code. |
| amount | number | Fiat amount. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| platform | string | Payment platforms. |
| recipient | string | Recipient address. |
| quotesToReturn | number | Quote count. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"from": {
"type": "string",
"description": "Fiat currency code."
},
"amount": {
"type": "number",
"description": "Fiat amount."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"platform": {
"type": "string",
"description": "Payment platforms."
},
"recipient": {
"type": "string",
"description": "Recipient address."
},
"quotesToReturn": {
"type": "number",
"default": 10,
"description": "Quote count."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Check Peerlytics API credit balance and usage.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Query deposits from Peerlytics with filtering.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| offset | number | Offset. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| status | string | Deposit status. |
| currency | string | Fiat currencies. |
| delegate | string | Delegate address. |
| platform | string | Payment platforms. |
| accepting | boolean | Accepting intents. |
| depositor | string | Depositor address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"default": 50,
"description": "Result limit."
},
"offset": {
"type": "number",
"default": 0,
"description": "Offset."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"status": {
"type": "string",
"description": "Deposit status."
},
"currency": {
"type": "string",
"description": "Fiat currencies."
},
"delegate": {
"type": "string",
"description": "Delegate address."
},
"platform": {
"type": "string",
"description": "Payment platforms."
},
"accepting": {
"type": "boolean",
"description": "Accepting intents."
},
"depositor": {
"type": "string",
"description": "Depositor address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Look up a wallet address profile on Peerlytics.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| offset | number | Offset. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| address* | string | Address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"address"
],
"properties": {
"limit": {
"type": "number",
"default": 100,
"description": "Result limit."
},
"offset": {
"type": "number",
"default": 0,
"description": "Offset."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"address": {
"type": "string",
"description": "Address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Look up a deposit on Peerlytics.
| Argument | Type | Description |
|---|---|---|
| id* | string | Deposit ID. |
| limit | number | Result limit. |
| offset | number | Offset. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Deposit ID."
},
"limit": {
"type": "number",
"default": 100,
"description": "Result limit."
},
"offset": {
"type": "number",
"default": 0,
"description": "Offset."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Look up an intent on Peerlytics.
| Argument | Type | Description |
|---|---|---|
| hash* | string | Intent hash. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"hash"
],
"properties": {
"hash": {
"type": "string",
"description": "Intent hash."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Look up a maker profile on Peerlytics.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| address* | string | Maker address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"address"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"address": {
"type": "string",
"description": "Maker address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Search across addresses, deposits, intents, and vaults on Peerlytics.
| Argument | Type | Description |
|---|---|---|
| query* | string | Search query. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "Search query."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Look up a vault on Peerlytics.
| Argument | Type | Description |
|---|---|---|
| id* | string | Vault ID. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Vault ID."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Look up a verifier profile on Peerlytics.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| address* | string | Verifier address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"address"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"address": {
"type": "string",
"description": "Verifier address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Query intents from Peerlytics with filtering.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| owner | string | Owner address. |
| offset | number | Offset. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| status | string | Intent statuses. |
| depositId | string | Deposit IDs. |
| recipient | string | Recipient address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"default": 50,
"description": "Result limit."
},
"owner": {
"type": "string",
"description": "Owner address."
},
"offset": {
"type": "number",
"default": 0,
"description": "Offset."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"status": {
"type": "string",
"description": "Intent statuses."
},
"depositId": {
"type": "string",
"description": "Deposit IDs."
},
"recipient": {
"type": "string",
"description": "Recipient address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch maker and taker leaderboard data from Peerlytics.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| offset | number | Offset. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"default": 20,
"description": "Result limit."
},
"offset": {
"type": "number",
"default": 0,
"description": "Offset."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch maker activity history for an address from Peerlytics.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| address* | string | Maker address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"address"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"address": {
"type": "string",
"description": "Maker address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List supported currencies from Peerlytics.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List supported payment platforms from Peerlytics with method hashes.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch the live P2P orderbook from Peerlytics.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| minSize | number | Minimum size. |
| currency | string | Fiat currency. |
| platform | string | Payment platforms. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"minSize": {
"type": "number",
"default": 50,
"description": "Minimum size."
},
"currency": {
"type": "string",
"description": "Fiat currency."
},
"platform": {
"type": "string",
"description": "Payment platforms."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch aggregate Peerlytics protocol statistics.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch current market spreads from Peerlytics.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| currency | string | Fiat currencies. |
| platform | string | Payment platforms. |
| includeRates | boolean | Include rate entries. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"default": 200,
"description": "Result limit."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"currency": {
"type": "string",
"description": "Fiat currencies."
},
"platform": {
"type": "string",
"description": "Payment platforms."
},
"includeRates": {
"type": "boolean",
"description": "Include rate entries."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch taker activity history for an address from Peerlytics.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| address* | string | Taker address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"address"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"address": {
"type": "string",
"description": "Taker address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch Peerlytics vault analytics.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| offset | number | Offset. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"default": 50,
"description": "Result limit."
},
"offset": {
"type": "number",
"default": 0,
"description": "Offset."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch Peerlytics protocol volume and analytics for a time range.
| Argument | Type | Description |
|---|---|---|
| range | string | Analytics range. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| currency | string | Fiat currencies. |
| platform | string | Payment platforms. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"range": {
"type": "string",
"default": "mtd",
"description": "Analytics range."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"currency": {
"type": "string",
"description": "Fiat currencies."
},
"platform": {
"type": "string",
"description": "Payment platforms."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Check whether the current escrow deployment supports inline oracle configs.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| escrowAddress | string | Escrow address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"escrowAddress": {
"type": "string",
"description": "Escrow address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Validate bundled oracle feeds on-chain.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Resolve a payee hash from on-chain deposit data.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositId* | string | Deposit ID. |
| paymentMethodHash* | string | Payment method hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depositId",
"paymentMethodHash"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Deposit ID."
},
"paymentMethodHash": {
"type": "string",
"description": "Payment method hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch deposits for an owner directly from ProtocolViewer.
| Argument | Type | Description |
|---|---|---|
| owner | string | Owner address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"owner": {
"type": "string",
"description": "Owner address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch a deposit directly from ProtocolViewer.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositId* | string | Deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depositId"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch multiple deposits directly from ProtocolViewer.
| Argument | Type | Description |
|---|---|---|
| ids | string | Deposit IDs. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"ids": {
"type": "string",
"description": "Deposit IDs."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch intents for an owner directly from ProtocolViewer.
| Argument | Type | Description |
|---|---|---|
| owner | string | Owner address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"owner": {
"type": "string",
"description": "Owner address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch a single intent directly from ProtocolViewer.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| intentHash* | string | Intent hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"intentHash"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"intentHash": {
"type": "string",
"description": "Intent hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Get fiat-to-USDC exchange quotes.
| Argument | Type | Description |
|---|---|---|
| to | string | Destination token. |
| from | string | Fiat currency code. |
| user | string | User address. |
| amount | number | Fiat or token amount. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| platform | string | Payment platform. |
| recipient | string | Recipient address. |
| tokenAmount | number | Exact token amount. |
| quotesToReturn | number | Quote count. |
| destinationChainId | number | Destination chain. |
Read whether chargebackable intent admissions are paused.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read whether a stake owner authorizes a taker.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Stake owner address. |
| taker* | string | Taker address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"owner",
"taker"
],
"properties": {
"owner": {
"type": "string",
"description": "Stake owner address."
},
"taker": {
"type": "string",
"description": "Taker address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read total stake owned by an address.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Stake owner address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"owner"
],
"properties": {
"owner": {
"type": "string",
"description": "Stake owner address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read non-stake USDC claimable by a beneficiary.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| beneficiary* | string | Claim beneficiary address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"beneficiary"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"beneficiary": {
"type": "string",
"description": "Claim beneficiary address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read whether a deposit has dispute protection enabled for a payment method.
| Argument | Type | Description |
|---|---|---|
| escrow* | string | Escrow address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositId* | string | Deposit ID. |
| paymentMethod* | string | Payment method hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"escrow",
"depositId",
"paymentMethod"
],
"properties": {
"escrow": {
"type": "string",
"description": "Escrow address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Deposit ID."
},
"paymentMethod": {
"type": "string",
"description": "Payment method hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read stake available for withdrawal or a new lock.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Stake owner address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"owner"
],
"properties": {
"owner": {
"type": "string",
"description": "Stake owner address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read indexed staking, authorization, claim, and risk-window state with freshness metadata.
| Argument | Type | Description |
|---|---|---|
| taker* | string | Taker address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"taker"
],
"properties": {
"taker": {
"type": "string",
"description": "Taker address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read stake locked behind active chargeback windows.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Stake owner address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"owner"
],
"properties": {
"owner": {
"type": "string",
"description": "Stake owner address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Resolve the effective stake owner backing a taker.
| Argument | Type | Description |
|---|---|---|
| taker* | string | Taker address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"taker"
],
"properties": {
"taker": {
"type": "string",
"description": "Taker address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read the minimum collateral lock window for a payment method.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| paymentMethodHash* | string | Payment method hash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"paymentMethodHash"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"paymentMethodHash": {
"type": "string",
"description": "Payment method hash."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read the stake owner selected by a taker before authorization checks.
| Argument | Type | Description |
|---|---|---|
| taker* | string | Taker address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"taker"
],
"properties": {
"taker": {
"type": "string",
"description": "Taker address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Read the authoritative StakeVault state for a staker and optional taker.
| Argument | Type | Description |
|---|---|---|
| taker | string | Taker address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| staker* | string | Stake owner address. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"staker"
],
"properties": {
"taker": {
"type": "string",
"description": "Taker address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"staker": {
"type": "string",
"description": "Stake owner address."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List delegated deposits for a vault.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| offset | number | Offset. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| pagination | object | Pagination options. |
| rateManagerId* | string | Vault identifier. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"rateManagerId"
],
"properties": {
"limit": {
"type": "number",
"default": 50,
"description": "Result limit."
},
"offset": {
"type": "number",
"default": 0,
"description": "Offset."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"pagination": {
"type": "object",
"description": "Pagination options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"rateManagerId": {
"type": "string",
"description": "Vault identifier."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Read the effective rate for a delegated deposit pair.
| Argument | Type | Description |
|---|---|---|
| escrow | string | Escrow address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| currency | string | Fiat currency. |
| platform | string | Payment method. |
| depositId | string | Deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"escrow": {
"type": "string",
"description": "Escrow address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"currency": {
"type": "string",
"description": "Fiat currency."
},
"platform": {
"type": "string",
"description": "Payment method."
},
"depositId": {
"type": "string",
"description": "Deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}List vaults via the indexer.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| filter | object | Filter options. |
| offset | number | Offset. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| manager | string | Manager address. |
| pagination | object | Pagination options. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"default": 50,
"description": "Result limit."
},
"filter": {
"type": "object",
"description": "Filter options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"offset": {
"type": "number",
"default": 0,
"description": "Offset."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema2"
}
},
"manager": {
"type": "string",
"description": "Manager address."
},
"pagination": {
"type": "object",
"description": "Pagination options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
},
"__schema2": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema2"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema2"
}
}
]
}
}
}Read the effective manager fee for a delegated deposit.
| Argument | Type | Description |
|---|---|---|
| escrow | string | Escrow address. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| depositId | string | Deposit ID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"escrow": {
"type": "string",
"description": "Escrow address."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"depositId": {
"type": "string",
"description": "Deposit ID."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch manual rate updates for a vault.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| options | object | Query options. |
| rateManagerId* | string | Vault identifier. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"rateManagerId"
],
"properties": {
"limit": {
"type": "number",
"default": 50,
"description": "Result limit."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"options": {
"type": "object",
"description": "Query options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"rateManagerId": {
"type": "string",
"description": "Vault identifier."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Fetch oracle config updates for a vault.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| options | object | Query options. |
| rateManagerId* | string | Vault identifier. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"rateManagerId"
],
"properties": {
"limit": {
"type": "number",
"default": 50,
"description": "Result limit."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"options": {
"type": "object",
"description": "Query options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"rateManagerId": {
"type": "string",
"description": "Vault identifier."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}Show vault details by rateManagerId.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional raw JSON params merged beneath typed fields. |
| rateManagerId* | string | Vault identifier. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"rateManagerId"
],
"properties": {
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"rateManagerId": {
"type": "string",
"description": "Vault identifier."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}Fetch daily snapshots for a vault.
| Argument | Type | Description |
|---|---|---|
| limit | number | Result limit. |
| params | object | Optional raw JSON params merged beneath typed fields. |
| options | object | Snapshot options. |
| rateManagerId* | string | Vault identifier. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"rateManagerId"
],
"properties": {
"limit": {
"type": "number",
"default": 30,
"description": "Result limit."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
},
"options": {
"type": "object",
"description": "Snapshot options.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"rateManagerId": {
"type": "string",
"description": "Vault identifier."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema1"
}
}
]
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"to": {
"type": "string",
"default": "USDC",
"description": "Destination token."
},
"from": {
"type": "string",
"description": "Fiat currency code."
},
"user": {
"type": "string",
"description": "User address."
},
"amount": {
"type": "number",
"description": "Fiat or token amount."
},
"params": {
"type": "object",
"description": "Optional raw JSON params merged beneath typed fields.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
},
"platform": {
"type": "string",
"description": "Payment platform."
},
"recipient": {
"type": "string",
"description": "Recipient address."
},
"tokenAmount": {
"type": "number",
"description": "Exact token amount."
},
"quotesToReturn": {
"type": "number",
"default": 5,
"description": "Quote count."
},
"destinationChainId": {
"type": "number",
"default": 8453,
"description": "Destination chain."
}
},
"definitions": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/__schema0"
}
}
]
}
}
}