Ctrl+K

Create reports for an enterprise.

post/api/v2/admin/enterprise/reports

Request Body

type string required
Allowed values: holdings transactions quarterly trades staking holdingsByAddress organizationHoldings organizationHoldingsByAddress organizationTransactions organizationTrades organizationStaking
format string required
Allowed values: csv pdf
holdings object
Holdings report
byWallet boolean
enterprise string required
ID of the enterprise
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
includeStaking boolean
snapshotDate string <date-time>required
Date of the snapshot
transactions object
Transactions report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isAddressReport boolean
isDetailed boolean
startDate string <date-time>required
Date of the snapshot
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
quarterly object
Quarterly report
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
startDate string <date-time>required
Date of the snapshot
trades object
Trades report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isFillsReport boolean
startDate string <date-time>required
Date of the snapshot
staking object
Staking report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isBalanceReport boolean
startDate string <date-time>required
Date of the snapshot
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
holdingsByAddress object
Address-level Holdings report
assets array[string]
enterprise string required
Min length: >= 1 characters
snapshotDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationHoldings object
Organization-level Holdings report
byWallet boolean
enterprises array[string]
includeStaking boolean
organization string required
Min length: >= 1 characters
snapshotDate string <date-time>required
organizationTransactions object
Organization-level Transactions report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isAddressReport boolean
isDetailed boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationHoldingsByAddress object
Organization-level Holdings by Address report
assets array[string]
enterprises array[string]
organization string required
Min length: >= 1 characters
snapshotDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationStaking object
Organization-level Staking report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isBalanceReport boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationTrades object
Organization-level Trades report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isFillsReport boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required

200 Response

isAdminRequest boolean required
holdings object
Holdings report
byWallet boolean
enterprise string required
ID of the enterprise
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
includeStaking boolean
snapshotDate string <date-time>required
Date of the snapshot
transactions object
Transactions report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isAddressReport boolean
isDetailed boolean
startDate string <date-time>required
Date of the snapshot
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
quarterly object
Quarterly report
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
startDate string <date-time>required
Date of the snapshot
trades object
Trades report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isFillsReport boolean
startDate string <date-time>required
Date of the snapshot
staking object
Staking report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isBalanceReport boolean
startDate string <date-time>required
Date of the snapshot
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
holdingsByAddress object
Address-level Holdings report
assets array[string]
enterprise string required
Min length: >= 1 characters
snapshotDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationHoldings object
Organization-level Holdings report
byWallet boolean
enterprises array[string]
includeStaking boolean
organization string required
Min length: >= 1 characters
snapshotDate string <date-time>required
organizationTransactions object
Organization-level Transactions report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isAddressReport boolean
isDetailed boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationHoldingsByAddress object
Organization-level Holdings by Address report
assets array[string]
enterprises array[string]
organization string required
Min length: >= 1 characters
snapshotDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationStaking object
Organization-level Staking report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isBalanceReport boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationTrades object
Organization-level Trades report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isFillsReport boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required
id string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
type string required
Type of report
Allowed values: holdings transactions quarterly trades staking holdingsByAddress organizationHoldings organizationHoldingsByAddress organizationTransactions organizationTrades organizationStaking
format string required
Format of report
Allowed values: csv pdf
status string required
Status of report
Allowed values: pending processing completed failed
createdAt string <date-time>required
Date report was created
completedAt string <date-time>
Date report was completed
documentName string
Name of the report document
Min length: >= 1 characters
user string required
ID of the user who requested the report
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

500 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id