HTTP API reference › GalaSwap DEX › Schemas

GalaSwap DEX — schemas

180 named schemas. Request and response tables on the group pages link here.

ActiveIncentiveProgramResponse

Type: object

Field	Type	Required	Description
id	number	yes
name	string	yes
poolHash	string	yes
bonusToken	string nullable	yes
bonusPoolAmount	string nullable	yes
status	string enum: PENDING, ACTIVE, COMPLETED, CANCELLED	yes
startTime	string (date-time)	yes
endTime	string (date-time)	yes
requiresFullRange	boolean	yes
minPositionValueUsd	number nullable	yes
termsUrl	string nullable	yes
totalTvl	string	yes
participantCount	number	yes

AddLiquidityEstimateResponseDto

Type: object

Field	Type	Required	Description
amount0	string	yes
amount1	string	yes
liquidity	string	yes
token0Symbol	string	yes
token1Symbol	string	yes
tickLower	number	yes
tickUpper	number	yes
amountIsCanonicalToken0	boolean	yes

AddLiquidityEstimateResponseEnvelopeDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	AddLiquidityEstimateResponseDto	yes

ApiErrorEnvelope

Shared error response envelope returned by the backend.

Type: object

Field	Type	Required	Description
status	integer	yes
error	boolean	yes
message	string	yes
errorKey	string	no

AssetDto

Type: object

Field	Type	Required	Description
id	string	yes
name	string	yes
symbol	string	yes
decimals	number	yes

BaseResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	object	yes
data	object	yes

BlockDto

Type: object

Field	Type	Required	Description
blockNumber	number	yes
blockTimestamp	number	yes

ChainQueuedWriteDataResponseDto

Type: object

Field	Type	Required	Description
mode	string enum: queued	yes
transactionId	string	no
uniqueKey	string	no
blockNumber	number	no

ChainSubmissionResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean	yes
message	string	yes
data	oneOf: ChainSyncWriteDataResponseDto | ChainQueuedWriteDataResponseDto	yes

ChainSyncWriteDataResponseDto

Type: object

Field	Type	Required	Description
mode	string enum: sync	yes
transactionId	string	yes
result	object	yes	Executed chain result; fields depend on the registered method.
blockNumber	number	no

ChestOpenResponse

Type: object

Field	Type	Required	Description
id	number	yes
tierNumber	number	yes
tierName	string	no
keysUsed	number	yes
status	string enum: PENDING, PROCESSING, FULFILLED, FAILED	yes
rewardPacks	array<CompetitionRewardPackResponseDto> nullable	yes
openedAt	string	yes

CoinGeckoBadRequestResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean	yes
message	string	yes

CoinGeckoTickerResponseDto

Type: object

Field	Type	Required	Description
ticker_id	string	yes
base_currency	string	yes
target_currency	string	yes
last_price	number	yes
base_volume	number	yes
target_volume	number	yes
pool_id	string	yes
liquidity_in_usd	number	yes

CompetitionChestTierResponseDto

Type: object

Field	Type	Required	Description
tierNumber	number	yes
name	string	yes
keysRequired	number	yes
exchangeId	number	no
redemptionCode	string	no
budgetUsd	number	no

CompetitionEnrolledInventoryResponseDto

Type: object

Field	Type	Required	Description
enrolled	boolean enum: true	yes
keys	KeyInventory	yes
grandPrizeEntry	boolean	yes
totalVolume	number	yes
rank	number nullable	yes

CompetitionErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

CompetitionGrandPrizeResponseDto

Type: object

Field	Type	Required	Description
name	string	yes
valueUsd	number	yes
description	string	no
imageUrl	string	no

CompetitionLeaderboardResponseDto

Type: object

Field	Type	Required	Description
entries	array<LeaderboardEntry>	yes
totalParticipants	number	yes
totalVolume	number	yes
userPosition	LeaderboardEntry	no

CompetitionNotEnrolledInventoryResponseDto

Type: object

Field	Type	Required	Description
enrolled	boolean enum: false	yes
keys	KeyInventory	yes
grandPrizeEntry	boolean enum: false	yes

CompetitionResponse

Type: object

Field	Type	Required	Description
id	number	yes
name	string	yes
description	string nullable	yes
poolHashes	array<string>	yes
startTime	string	yes
endTime	string	yes
status	string enum: PENDING, ACTIVE, COMPLETED, CANCELLED	yes
keyThresholdUsd	number	yes
grandPrizeConfig	object nullable CompetitionGrandPrizeResponseDto	yes
termsUrl	string nullable	yes
bannerImageUrl	string nullable	yes
isActive	boolean	yes
timeRemaining	number nullable	yes
totalParticipants	number	yes
totalVolume	number	yes
chestTierConfig	array<CompetitionChestTierResponseDto> nullable	yes

CompetitionRewardItemResponseDto

Type: object

Field	Type	Required	Description
id	number	yes
fulfillmentType	string enum: galachain_mint, galachain_transfer, object_api_item	yes
fulfillmentSubType	string	yes
collection	string	yes
category	string	yes
type	string	yes
additionalKey	string	yes
quantity	number	yes
dynamicMetadataId	string	no

CompetitionRewardPackResponseDto

Type: object

Field	Type	Required	Description
id	number	yes
claimedBy	string	no
claimedTransactionHash	string	no
items	array<CompetitionRewardItemResponseDto>	yes

CompetitionStatsResponse

Type: object

Field	Type	Required	Description
competitionId	number	yes
totalParticipants	number	yes
totalVolume	number	yes
totalKeysAwarded	number	yes
totalChestsOpened	object	yes
grandPrizeEntries	number	yes

CompositePoolResponseDataDto

Type: object

Field	Type	Required	Description
pool	PoolDataResponseDto	yes
currentTradingPrice	CurrentTradingPriceResponseDto	yes
initializedTicks	array<InitializedTickResponseDto>	no
reverseInitializedTicks	array<InitializedTickResponseDto>	no
positionBoundaries	array<>	no
positions	array<CompositePositionResponseDto>	no
activeLiquidity	string	no
token0TradingSymbol	TradingSymbolBalanceResponseDto	no
token1TradingSymbol	TradingSymbolBalanceResponseDto	no
token0LiquidityBalance	TokenBalanceResponseDto	no
token1LiquidityBalance	TokenBalanceResponseDto	no
token0ProtocolFeesBalance	TokenBalanceResponseDto	no
token1ProtocolFeesBalance	TokenBalanceResponseDto	no

CompositePoolResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	CompositePoolResponseDataDto	yes

CompositePositionResponseDto

Type: object

Field	Type	Required	Description
pool	string	yes
lexigraphicTickIndexLow	string	yes
lexigraphicTickIndexHigh	string	yes
owner	string	yes
liquidity	string	yes

CurrentTradingPriceResponseDto

Type: object

Field	Type	Required	Description
token0	string	yes
token1	string	yes
fee	number	yes
price	string	yes
sqrtPrice	string	yes
tick	number	yes

DailyVolumeAndFeesResponseDto

Type: object

Field	Type	Required	Description
pairId	string	no
timezone	string	yes
date	string	yes
volumeUSD	number	yes
feesUSD	number	yes

EnrollDto

Type: object

Field	Type	Required	Description
walletAddress	string	yes

EnrollPositionDto

Type: object

Field	Type	Required	Description
programId	number	yes	Incentive program identifier.
walletAddress	string	yes	Synthetic or caller wallet reference that owns the position.
tickLower	number	yes	Lower tick bound of the enrolled position.
tickUpper	number	yes	Upper tick bound of the enrolled position.
termsAcceptedTxHash	string	no	Transaction hash proving acceptance of program terms.

ExtensionVersionCheckResponseDto

Type: object

Field	Type	Required	Description
supported	boolean	yes
minVersion	string	yes
currentVersion	string nullable	yes

ExtensionVersionUpgradeRequiredResponseDto

Type: object

Field	Type	Required	Description
error	string enum: extension_update_required	yes
minVersion	string	yes
currentVersion	string	yes

GenerateWidgetUrlDataDto

Type: object

Field	Type	Required	Description
url	string	yes

GenerateWidgetUrlDto

Type: object

Field	Type	Required	Description
walletAddress	string	yes	Wallet receiving the purchased or swapped crypto.
mode	string enum: buy, sell, swap	no	Widget transaction mode.
defaultFiat	string	no	Fiat currency code.
defaultAmount	number	no	Default fiat amount.
sellDefaultAmount	number	no	Default crypto amount for sell mode.
onlyCryptoNetworks	string	no	Allowed crypto network identifiers.
defaultPaymentMethod	string	no	Default payment method.
defaultCrypto	string	no	Default crypto ticker.
onlyPaymentMethods	string	no	Allowlisted payment methods.
excludePaymentMethods	string	no	Payment methods excluded from the widget.
onlyFiat	string	no	Allowlisted fiat currencies.
excludeFiat	string	no	Fiat currencies excluded from the widget.
isAddressEditable	string	no	Whether the user can edit the wallet address, encoded as a string.
networkPrefix	string	no	Onramper network prefix.

GenerateWidgetUrlResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean	yes
message	string	yes
data	GenerateWidgetUrlDataDto	yes

GetAssetResponseDto

Type: object

Field	Type	Required	Description
asset	AssetDto	yes

GetEventsResponseDto

Type: object

Field	Type	Required	Description
events	array<oneOf: SwapEventDto | JoinExitEventDto>	yes

GetPairResponseDto

Type: object

Field	Type	Required	Description
pair	PairDto	yes

IncentiveErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

IncentiveProgramAnalyticsResponseDto

Type: object

Field	Type	Required	Description
id	number	yes
programId	number	yes
snapshotTime	string (date-time)	yes
periodType	string enum: REALTIME, HOURLY, DAILY	yes
tvlUsd	number	yes
volume24hUsd	number	yes
fees24hUsd	number	yes
trailingApr24h	number nullable	yes
trailingApr7d	number nullable	yes
uniqueLpCount	number	yes
totalPositions	number	yes
qualifiedPositions	number	yes
totalFeesDistributed	number	yes
createdAt	string (date-time)	yes

IncentiveProgramPositionResponseDto

Type: object

Field	Type	Required	Description
id	number	yes
programId	number	yes
walletAddress	string	yes
owner	string nullable	yes
positionId	string	yes
tickLower	number nullable	yes
tickUpper	number nullable	yes
initialLiquidity	string	yes
initialValueUsd	number nullable	yes
isFullRange	boolean	yes
isQualified	boolean	yes
enrolledAt	string (date-time)	yes
disqualifiedAt	string (date-time) nullable	yes
disqualificationReason	string nullable	yes
termsAcceptedAt	string (date-time) nullable	yes
termsAcceptedIp	string nullable	yes
createdAt	string (date-time)	yes
updatedAt	string (date-time)	yes

IncentiveRewardResponse

Type: object

Field	Type	Required	Description
programId	number	yes
programName	string	yes
status	string enum: ACTIVE, COMPLETED, DISQUALIFIED, CALCULATING	yes
bonusTokenSymbol	string	yes
bonusTokenReward	string	yes
sharePercentage	string	yes
isQualified	boolean	yes
disqualificationReason	string	no
timeRemainingSeconds	number	yes
distributionTxHash	string	no
programStartTime	string (date-time)	yes
programEndTime	string (date-time)	yes

InitializedTickResponseDto

Type: object

Field	Type	Required	Description
pool	string	yes
lexigraphicTickIndex	string	yes

JoinExitEventDto

Type: object

Field	Type	Required	Description
txnId	string	yes
txnIndex	number	yes
eventIndex	number	yes
block	BlockDto	yes
maker	string	yes
pairId	string	yes
eventType	string enum: join, exit	yes
amount0	string	yes
amount1	string	yes
reserves	TerminalReservesDto	yes

KeyInventory

Type: object

Field	Type	Required	Description
total	number	yes
canAfford	object	yes

LatestBlockResponseDto

Type: object

Field	Type	Required	Description
block	BlockDto	yes

LeaderboardEntry

Type: object

Field	Type	Required	Description
rank	number	yes
walletAddress	string	yes
totalVolumeUsd	number	yes
keysEarned	number	yes

LeaderboardEntryResponseDto

Type: object

Field	Type	Required	Description
wallet	string	yes
rank	number	yes
total_xp	string nullable	no
distribution_percent	string	yes
liquidity_xp	string	yes
trading_xp	string	yes
mastery_titles	array<LeaderboardMasteryTitleResponseDto>	yes

LeaderboardMasteryTitleResponseDto

Type: object

Field	Type	Required	Description
name	string	yes
type	string	yes
order	number	yes

LeaderboardResponseDto

Type: object

Field	Type	Required	Description
leaderboard	array<LeaderboardEntryResponseDto>	yes

LeaderboardRewardPageMetaResponseDto

Type: object

Field	Type	Required	Description
currentPage	number	yes
itemsPerPage	number	yes
totalPages	number	yes
totalItems	number	yes
hasNextPage	boolean	yes
hasPreviousPage	boolean	yes

LeaderboardRewardPageResponseDto

Type: object

Field	Type	Required	Description
items	array<LeaderboardWalletRewardResponseDto>	yes
meta	LeaderboardRewardPageMetaResponseDto	yes

LeaderboardSeasonResponseDto

Type: object

Field	Type	Required	Description
id	number	yes
name	string	yes
start	string (date-time)	yes
end	string (date-time)	yes
rules_id	number	yes

LeaderboardUserBreakdownResponseDto

Type: object

Field	Type	Required	Description
details	nullable LeaderboardWalletDetailResponseDto oneOf: LeaderboardWalletDetailResponseDto | object nullable enum:	yes
rewards	LeaderboardRewardPageResponseDto	yes

LeaderboardUserPositionDetailsResponseDto

Type: object

Field	Type	Required	Description
liquidity_xp	string nullable	yes
trading_xp	string nullable	yes
token_variety	string nullable	yes
token_variety_names	string nullable	yes
tvl_days_provisioned	number nullable	yes
tvl	string nullable	yes
tvl_increased	string nullable	yes
mastery_titles	array<LeaderboardMasteryTitleResponseDto> nullable	yes
season_id	number nullable	yes
created_at	string (date-time) nullable	yes
id	number	yes
wallet_address	string nullable	yes
total_xp	string	yes
distribution_percent	string	yes

LeaderboardUserPositionResponseDto

Type: object

Field	Type	Required	Description
position	number nullable	yes
details	nullable LeaderboardUserPositionDetailsResponseDto oneOf: LeaderboardUserPositionDetailsResponseDto | object nullable enum:	yes

LeaderboardWalletDetailResponseDto

Type: object

Field	Type	Required	Description
liquidity_xp	string nullable	yes
trading_xp	string nullable	yes
token_variety	string nullable	yes
token_variety_names	string nullable	yes
tvl_days_provisioned	number nullable	yes
tvl	string nullable	yes
tvl_increased	string nullable	yes
mastery_titles	array<LeaderboardMasteryTitleResponseDto> nullable	yes
season_id	number nullable	yes
created_at	string (date-time) nullable	yes
id	number	yes
wallet_address	string nullable	yes
total_xp	string nullable	yes

LeaderboardWalletRewardResponseDto

Type: object

Field	Type	Required	Description
id	number	yes
wallet_address	string nullable	yes
xp_type	string nullable	yes
xp_activity	string nullable	yes
xp_amount	string nullable	yes
season_id	number nullable	yes
created_at	string (date-time) nullable	yes

LiquidityOperationDto

Type: object

Field	Type	Required	Description
operationId	string	yes
poolHash	string	yes
positionId	string	yes
transactionId	string	yes
feeTier	string	yes
token0ClassKeyId	string	yes
token1ClassKeyId	string	yes
blockNumber	number	yes
transactionTimestamp	string	yes
transactionMethod	string enum: AddLiquidity, RemoveLiquidity	yes
userAddress	string	yes
token0Amount	string	yes
token1Amount	string	yes
tickLower	number	no
tickUpper	number	no
liquidity	string	no

LiquidityOperationEdgeResponseDto

Type: object

Field	Type	Required	Description
node	LiquidityOperationDto	yes

MarketErrorResponseDto

Type: object

Field	Type	Required	Description
status	boolean	yes
message	string	yes

MarketOhlcvPointResponseDto

Type: object

Field	Type	Required	Description
time	oneOf: string | number	yes
open	number	yes
high	number	yes
low	number	yes
close	number	yes
volume	number	no

MarketplaceErrorResponseDto

Type: object

Field	Type	Required	Description
status	boolean	yes
message	string	yes

MarketplaceHttpErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	string	yes
error	string	yes

MarketplaceListingPageResponseDto

Type: object

Field	Type	Required	Description
items	array<MarketplaceListingResponseDto>	yes
total	number	yes
page	number	yes
limit	number	yes

MarketplaceListingResponseDto

Type: object

Field	Type	Required	Description
id	string	yes
nftClass	string nullable	yes
instance	string nullable	yes
collection	string nullable	yes
name	string nullable	yes
image	string nullable	yes
rarity	string nullable	yes
price	MarketplacePriceResponseDto	yes
seller	string	yes
channel	string	yes
mode	string enum: native, brokered	yes
bundleCount	number	yes
expires	string	yes
created	string	yes
deepLink	string (uri)	yes

MarketplacePriceResponseDto

Type: object

Field	Type	Required	Description
currency	string	yes
amount	string	yes
num	number	yes

MarketplaceRateLimitResponseDto

Type: object

Field	Type	Required	Description
status	boolean	yes
message	string	yes
retryAfter	number	yes

MarketPriceResponseDto

Type: object

Field	Type	Required	Description
price	number nullable	yes
change24h	number nullable	yes
listed	boolean	yes

MarketPriceSeriesPointResponseDto

Type: object

Field	Type	Required	Description
time	number	yes	Unix time in seconds
price	number	yes

MarketPriceSeriesResponseDto

Type: object

Field	Type	Required	Description
prices	array<MarketPriceSeriesPointResponseDto>	yes
currentPrice	number nullable	yes
change24h	number nullable	yes

MarketTokenSeriesResponseDto

Type: object

Field	Type	Required	Description
ohlcv	array<MarketOhlcvPointResponseDto>	yes
currentPrice	number nullable	yes
change24h	number nullable	yes
volume24h	number nullable	yes
source	string enum: inhouse, coingecko, chainmeter, none	yes

MarketWalletSwapResponseDto

Type: object

Field	Type	Required	Description
block_number	number	yes
tx_number	string	yes
created_at	string (date-time)	yes
creator	string	yes
sender	string	yes
recipient	string	yes
tx_type	string enum: GalaChainDex:Trade, DexV3Contract:Swap	yes
tx_subtype	string enum: Swap	yes
quantity	number	yes
tx_validation_code	string enum: 0	yes
tx_validation_enum	string enum: VALID	yes
usd_volume	number	yes
swap_token_0_amt	number	yes
swap_token_1_amt	number	yes
swap_token_0_name	string nullable	yes
swap_token_1_name	string nullable	yes
swap_token_0_image	string nullable	yes
swap_token_1_image	string nullable	yes
swap_token_0_asset_id	string nullable	yes
swap_token_1_asset_id	string nullable	yes
unique_key	string	yes
pool_hash	string	yes

OnboardingCustomErrorResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean	yes
message	string	yes

OnboardingHttpErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

OnboardingRegisteredDataResponseDto

Type: object

Field	Type	Required	Description
exist	boolean	yes

OnboardingRegisteredResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean	yes
message	string	yes
data	OnboardingRegisteredDataResponseDto	no

OpenChestDto

Type: object

Field	Type	Required	Description
walletAddress	string	yes
tierNumber	number	yes

OpenChestResponse

Type: object

Field	Type	Required	Description
success	boolean	yes
chestOpenId	number	yes
tierNumber	number	yes
tierName	string	yes
keysUsed	number	yes
rewardPacks	array<CompetitionRewardPackResponseDto>	yes
message	string	yes

PairDto

Type: object

Field	Type	Required	Description
id	string	yes
dexKey	string	yes
asset0Id	string	yes
asset1Id	string	yes
feeBps	number	yes

PairResultResponseDto

Type: object

Field	Type	Required	Description
pairId	string	yes
name	string nullable	yes

PairsHttpErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

PairsResponseDto

Type: object

Field	Type	Required	Description
date	string	yes
timezone	string	yes
pairs	array<PairResultResponseDto>	yes

ParticipantResponse

Type: object

Field	Type	Required	Description
id	number	yes
competitionId	number	yes
walletAddress	string	yes
totalVolumeUsd	number	yes
keysEarned	number	yes
keysSpent	number	yes
grandPrizeEntry	boolean	yes
enrolledAt	string	yes
rank	number nullable	yes
availableKeys	KeyInventory	yes
chestOpens	array<ChestOpenResponse>	yes

PoolDataResponseDto

Type: object

Field	Type	Required	Description
fee	number	yes
tickSpacing	number	yes
protocolFees	number	yes
tradingFees	number	yes
creator	string	no
token0	string	yes
token1	string	yes
name	string	no
token0Key	string	yes
token1Key	string	yes
isPrivate	boolean	no

PoolListRowResponseDto

Type: object

Field	Type	Required	Description
fee	number	yes
tickSpacing	number	yes
protocolFees	number	yes
tradingFees	number	yes
creator	string	no
token0CompositeKey	string	no
token1CompositeKey	string	no
token0Image	string	yes
token1Image	string	yes
contractVersion	string enum: v2	yes
token0	string	yes
token1	string	yes
poolName	string	yes
poolRef	string	yes
price	string	no
sqrtPrice	string	no
tick	number	no
token0Tvl	string	no
token1Tvl	string	no
tvlUsd	number	no
volume1d	number	no
volume7d	number	no
volume30d	number	no
trades1d	number	no
fee24h	number	no
apr1d	number	no
token0Price	number	no
token1Price	number	no

PoolResponseDataDto

Type: object

Field	Type	Required	Description
fee	number	yes
tickSpacing	number	yes
protocolFees	number	yes
tradingFees	number	yes
creator	string	no
token0	string	yes
token1	string	yes
name	string	no
token0Key	string	yes
token1Key	string	yes
isPrivate	boolean	no
flippedFromRequest	boolean	yes

PoolResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	PoolResponseDataDto	yes

PoolsResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	array<PoolListRowResponseDto>	yes

PoolSweepResultResponseDto

Type: object

Field	Type	Required	Description
poolHash	string	yes
pool	string	yes
contract	string enum: v1, v2	yes
status	string enum: no-fees, dust-carried-forward, dry-run, collected, failed	yes
collected	object	yes
submissionKey	string nullable	yes
txId	string nullable	yes
blockNumber	number	no
detail	string	yes

PositionResponseDataDto

Type: object

Field	Type	Required	Description
fee	number	yes
token0CompositeKey	string	no
token1CompositeKey	string	no
token0Image	string	yes
token1Image	string	yes
pool	string	yes
token0Symbol	string	yes
token1Symbol	string	yes
tickLower	number	yes
tickUpper	number	yes
owner	string	yes
liquidity	string	yes
amount0	string	yes
amount1	string	yes
inRange	boolean	yes
currentTick	number	no
sqrtPrice	string	no
fees0	string	no
fees1	string	no

PositionResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	SinglePositionResponseDataDto	yes

PositionsResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	array<PositionResponseDataDto>	yes

ProtocolFeeSweepHttpErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

QuoteDataResponseDto

Type: object

Field	Type	Required	Description
contractVersion	string enum: v2	yes
fee	number	yes
amountIn	string	yes
amountOut	string	yes
currentSqrtPrice	string	yes
newSqrtPrice	string	yes
newTick	number	yes
tradingFees	string	yes
protocolFees	string	yes
totalFees	string	yes
feeTokenSymbol	string	yes
token0Symbol	string	yes
token1Symbol	string	yes
tokenInIsToken0	boolean	yes

QuoteResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	QuoteDataResponseDto	yes

RemoveLiquidityEstimateResponseDto

Type: object

Field	Type	Required	Description
amount0	string	yes
amount1	string	yes

RemoveLiquidityEstimateResponseEnvelopeDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	RemoveLiquidityEstimateResponseDto	yes

ShadowChallengeDataResponseDto

Type: object

Field	Type	Required	Description
nonce	string	yes
message	string	yes
expiresAt	string (date-time)	yes

ShadowChallengeResponseDto

Type: object

Field	Type	Required	Description
status	string enum: success	yes
data	ShadowChallengeDataResponseDto	yes

ShadowHistoryDataResponseDto

Type: object

Field	Type	Required	Description
items	array<ShadowHistoryRowResponseDto>	yes
count	number	yes

ShadowHistoryResponseDto

Type: object

Field	Type	Required	Description
status	string enum: success	yes
data	ShadowHistoryDataResponseDto	yes

ShadowHistoryRowResponseDto

Type: object

Field	Type	Required	Description
id	string	yes
txHash	string nullable	yes
status	string enum: pending, confirmed, failed, unconfirmed, unverifiable	yes
blockNumber	number nullable	yes
timestamp	string (date-time)	yes
soldTokenAssetId	string	yes
receivedTokenAssetId	string	yes
soldAmount	number nullable	yes
receivedAmount	number nullable	yes
usdVolume	number nullable	yes
isShadow	boolean enum: true	yes
poolRecipient	string	no

ShadowHttpErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

ShadowSessionRequestDto

Type: object

Field	Type	Required	Description
signature	string	yes	personal_sign signature of the challenge message returned by /challenge

ShadowSessionResponseDto

Type: object

Field	Type	Required	Description
status	string enum: success	yes
data	ShadowSessionTokenResponseDto	yes

ShadowSessionTokenResponseDto

Type: object

Field	Type	Required	Description
token	string	yes
tokenType	string enum: Bearer	yes
expiresAt	string (date-time)	yes

SinglePositionResponseDataDto

Type: object

Field	Type	Required	Description
fee	number	yes
token0CompositeKey	string	no
token1CompositeKey	string	no
token0Image	string	yes
token1Image	string	yes
pool	string	yes
token0Symbol	string	yes
token1Symbol	string	yes
tickLower	number	yes
tickUpper	number	yes
owner	string	yes
liquidity	string	yes
amount0	string	yes
amount1	string	yes
inRange	boolean	yes
currentTick	number	no
sqrtPrice	string	no
fees0	string	no
fees1	string	no

Slot0ResponseDataDto

Type: object

Field	Type	Required	Description
token0	string	yes
token1	string	yes
fee	number	yes
price	string	yes
sqrtPrice	string	yes
tick	number	yes
flippedFromRequest	boolean	yes

Slot0ResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	Slot0ResponseDataDto	yes

SwapEventDto

Type: object

Field	Type	Required	Description
txnId	string	yes
txnIndex	number	yes
eventIndex	number	yes
block	BlockDto	yes
maker	string	yes
pairId	string	yes
eventType	string enum: swap	yes
asset0In	string	no
asset1In	string	no
asset0Out	string	no
asset1Out	string	no
priceNative	string	yes
reserves	TerminalReservesDto	yes

SweepReportResponseDto

Type: object

Field	Type	Required	Description
startedAt	string (date-time)	yes
finishedAt	string (date-time)	yes
dryRun	boolean	yes
destination	string	yes
poolsScanned	number	yes
poolsCollected	number	yes
poolsSkippedDust	number	yes
poolsFailed	number	yes
totalsByToken	object	yes
pools	array<PoolSweepResultResponseDto>	yes

SymbolsResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	array<TradingSymbolResponseDto>	yes

TerminalNotFoundResponseDto

Type: object

Field	Type	Required	Description
message	string	yes
error	string	yes
statusCode	number	yes

TerminalReservesDto

Type: object

Field	Type	Required	Description
asset0	string	yes
asset1	string	yes

TokenBalanceResponseDto

Type: object

Field	Type	Required	Description
collection	string	no
category	string	no
type	string	no
additionalKey	string	no
quantity	string	no
owner	string	no

TokenDTO

Type: object

Field	Type	Required	Description
collection	string	yes
category	string	yes
type	string	yes
additionalKey	string	yes

TokenRegistryKeyListResponseDto

Type: object

Field	Type	Required	Description
compositeKeys	array<string>	yes
count	number	yes

TokenSupplyHttpErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

TokenSupplyResponseDto

Type: object

Field	Type	Required	Description
data	array<TokenSupplyRowResponseDto>	yes

TokenSupplyRowResponseDto

Type: object

Field	Type	Required	Description
collection	string	yes
category	string	yes
type	string	yes
additionalKey	string	yes
decimals	number	no
name	string	no
symbol	string	no
description	string	no
image	string	no
network	string	no
isNonFungible	boolean	no
knownMintAllowanceSupply	string	yes
knownMintSupply	string	yes
maxCapacity	string	yes
maxSupply	string	yes
totalBurned	string	yes
totalSupply	string	yes
tokenClass	string	yes
circulatingSupply	string	yes

TradeCustomErrorResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean	yes
message	string	yes

TradeGraphDataPointResponseDto

Type: object

Field	Type	Required	Description
volume	number	yes
startDate	string	yes
endDate	string	yes
displayTime	string	yes

TradeGraphDataResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	no
data	array<TradeGraphDataPointResponseDto>	yes

TradeIndexedTransactionEnvelopeResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	no
data	TradeIndexedTransactionResponseDto	yes

TradeIndexedTransactionResponseDto

Type: object

Field	Type	Required	Description
transactionId	string nullable	yes
blockNumber	number	yes
poolHash	string nullable	yes
userAddress	string nullable	yes
transactionTime	string nullable	yes
token0	string nullable	yes
token1	string nullable	yes
amount0	number nullable	yes
amount1	number nullable	yes
volume	number nullable	yes

TradePoolAttributesResponseDto

Type: object

Field	Type	Required	Description
poolPair	string	yes
poolHash	string	yes
token0	string	yes
token0Image	string	yes
token1	string	yes
token1Image	string	yes
token0CompositeKey	string nullable	yes
token1CompositeKey	string nullable	yes
token0OriginChain	string nullable	yes
token1OriginChain	string nullable	yes
token0Price	string	yes
token1Price	string	yes
poolName	string	yes
fee	string	yes
fee24h	number	yes
token0Tvl	number	yes
token0TvlUsd	number	yes
token1Tvl	number	yes
token1TvlUsd	number	yes
tvl	number	yes
volume1d	number	yes
volume30d	number	yes
volume7d	number	yes
trades1d	number	yes
poolCreatedAt	string nullable	yes
dayPerTvl	number	yes
apr1d	number	yes
signals	array<string enum: new-active, trending, high-turnover, high-fee, top-volume, bot-viable>	yes
opportunityScore	number	yes
contractVersion	string enum: v1, v2	yes

TradePoolDetailResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	no
data	TradePoolAttributesResponseDto	yes

TradePoolListDataResponseDto

Type: object

Field	Type	Required	Description
pools	array<TradePoolAttributesResponseDto>	yes
count	number	yes

TradePoolListResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	no
data	TradePoolListDataResponseDto	yes

TradeSlot0ChainResponseDto

Type: object

Field	Type	Required	Description
Status	number enum: 1	yes
Message	string	no
ErrorCode	number	no
ErrorKey	string	no
ErrorPayload	object	no
Data	TradeSlot0DataResponseDto	no

TradeSlot0DataResponseDto

Type: object

Field	Type	Required	Description
sqrtPrice	string	yes
tick	number	no
liquidity	string	no
grossPoolLiquidity	string	no

TradeSlot0ResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	no
data	oneOf: TradeSlot0ChainResponseDto | object	yes

TradeTransactionResponseDto

Type: object

Field	Type	Required	Description
transactionId	string nullable	yes
blockNumber	number	yes
poolHash	string nullable	yes
userAddress	string nullable	yes
id	number	yes
uniqueKey	string nullable	yes
transactionTime	string nullable	yes
token0	string nullable	yes
token1	string nullable	yes
amount0	number nullable	yes
amount1	number nullable	yes
volume	number nullable	yes
createdAt	string (date-time)	yes
updatedAt	string (date-time)	yes

TradeTransactionsDataResponseDto

Type: object

Field	Type	Required	Description
transactions	array<TradeTransactionResponseDto>	yes
count	number	yes

TradeTransactionsResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	no
data	TradeTransactionsDataResponseDto	yes

TradeV2ErrorResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean	yes
message	string	yes
errorKey	string	no

TradeV2GraphDataPointResponseDto

Type: object

Field	Type	Required	Description
volume	number	yes
startDate	string	yes
endDate	string	yes
displayTime	string	yes

TradeV2GraphDataResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	array<TradeV2GraphDataPointResponseDto>	yes

TradeV2IndexedTransactionResponseDto

Type: object

Field	Type	Required	Description
transactionId	string nullable	yes
blockNumber	number	yes
poolHash	string nullable	yes
userAddress	string nullable	yes
transactionTime	string nullable	yes
token0	string nullable	yes
token1	string nullable	yes
amount0	number nullable	yes
amount1	number nullable	yes
volume	number nullable	yes

TradeV2OpportunitiesDataResponseDto

Type: object

Field	Type	Required	Description
pools	array<TradeV2OpportunityPoolResponseDto>	yes
count	number	yes

TradeV2OpportunitiesResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	TradeV2OpportunitiesDataResponseDto	yes

TradeV2OpportunityPoolResponseDto

Type: object

Field	Type	Required	Description
fee	number	yes
tickSpacing	number	yes
protocolFees	number	yes
tradingFees	number	yes
creator	string	no
token0CompositeKey	string	no
token1CompositeKey	string	no
token0Image	string	yes
token1Image	string	yes
contractVersion	string enum: v2	yes
token0	string	yes
token1	string	yes
poolName	string	yes
poolRef	string	yes
price	string	no
sqrtPrice	string	no
tick	number	no
token0Tvl	string	no
token1Tvl	string	no
tvlUsd	number	no
volume1d	number	no
volume7d	number	no
volume30d	number	no
trades1d	number	no
fee24h	number	no
apr1d	number	no
token0Price	number	no
token1Price	number	no
signals	array<string enum: new-active, trending, high-turnover, high-fee, top-volume, bot-viable>	yes
opportunityScore	number	yes

TradeV2PoolByHashResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	PoolListRowResponseDto	yes

TradeV2TransactionByUniqueKeyResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	TradeV2IndexedTransactionResponseDto	yes

TradeV2TransactionResponseDto

Type: object

Field	Type	Required	Description
transactionId	string nullable	yes
blockNumber	number	yes
poolHash	string nullable	yes
userAddress	string nullable	yes
id	number	yes
uniqueKey	string nullable	yes
transactionTime	string nullable	yes
token0	string nullable	yes
token1	string nullable	yes
amount0	number nullable	yes
amount1	number nullable	yes
volume	number nullable	yes
createdAt	string (date-time)	yes
updatedAt	string (date-time)	yes

TradeV2TransactionsDataResponseDto

Type: object

Field	Type	Required	Description
transactions	array<TradeV2TransactionResponseDto>	yes
count	number	yes

TradeV2TransactionsResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	TradeV2TransactionsDataResponseDto	yes

TradeV2ValidationErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

TradeValidationErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

TradeVolumeDataResponseDto

Type: object

Field	Type	Required	Description
id	number	yes
volume1d	number	yes
volume1dDelta	number	yes
volume7d	number	yes
volume7dDelta	number	yes
volume30d	number	yes
volume30dDelta	number	yes
tvl	number	yes

TradeVolumeResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	no
data	TradeVolumeDataResponseDto	yes

TradingSymbolBalanceResponseDto

Type: object

Field	Type	Required	Description
symbol	string	yes
decimals	number	yes

TradingSymbolResponseDto

Type: object

Field	Type	Required	Description
symbol	string	yes
collection	string	yes
category	string	yes
type	string	yes
additionalKey	string	yes
decimals	number	yes

UserAssetResponseDto

Type: object

Field	Type	Required	Description
isUngraduatedLaunchpad	boolean	no
price	number nullable	no
change24h	number nullable	no
listed	boolean	no
originChain	string nullable	no
listedAt	string nullable	no
image	string	yes
symbol	string	yes
name	string	yes
displayName	string	no
decimals	string	yes	Token decimal precision as a decimal string.
verify	boolean	yes
compositeKey	string	yes
quantity	string	no

UserAssetsDataResponseDto

Type: object

Field	Type	Required	Description
token	array<UserAssetResponseDto>	yes
count	number	yes

UserAssetsResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean	yes
message	string	yes
data	UserAssetsDataResponseDto	no

UserErrorResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: true	yes
message	string	yes

UserGalaBalanceDataResponseDto

Type: object

Field	Type	Required	Description
name	string	yes
quantity	number	yes
price	number	yes
holdingPrice	number	yes

UserGalaBalanceResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	yes
data	UserGalaBalanceDataResponseDto	no

UserTokenListDataResponseDto

Type: object

Field	Type	Required	Description
token	array<UserTokenResponseDto>	yes
count	number	yes
balancesAvailable	boolean enum: false	no

UserTokenListResponseDto

Type: object

Field	Type	Required	Description
status	number	yes
error	boolean enum: false	yes
message	string	yes
data	UserTokenListDataResponseDto	yes

UserTokenResponseDto

Type: object

Field	Type	Required	Description
isUngraduatedLaunchpad	boolean	no
price	number nullable	no
change24h	number nullable	no
listed	boolean	no
originChain	string nullable	no
listedAt	string nullable	no
id	number	no
name	string	yes
displayName	string	yes
symbol	string	yes
compositeKey	string	yes
collection	string	yes
category	string	yes
type	string	yes
additionalKey	string	yes
decimals	string	yes
description	string	yes
subscribePrice	boolean	yes
verify	boolean	yes
image	string	yes
quantity	string	no

UserValidationErrorResponseDto

Type: object

Field	Type	Required	Description
statusCode	number	yes
message	oneOf: string | array<string>	yes
error	string	no

VolumeSummaryResponseDto

Type: object

Field	Type	Required	Description
tvl	number	yes
volume1d	number	yes
volume7d	number	yes
volume30d	number	yes
trades1d	number	yes
volume1dDelta	number	yes
volume7dDelta	number	yes
volume30dDelta	number	yes

VolumeSummaryResponseEnvelopeDto

Type: object

Field	Type	Required	Description
status	number	yes
message	string	yes
error	boolean	yes
data	VolumeSummaryResponseDto	yes

WalletCompatBalanceNodeResponseDto

Type: object

Field	Type	Required	Description
node	WalletCompatBalanceRowResponseDto	yes

WalletCompatBalanceRowResponseDto

Type: object

Field	Type	Required	Description
channel	string	yes
owner	string	yes
collection	string	yes
category	string	yes
type	string	yes
additionalKey	string	yes
quantity	string	yes
decimals	string	yes
name	string	yes
image	string	yes
symbol	string	yes

WalletCompatErrorResponseDto

Type: object

Field	Type	Required	Description
status	boolean	yes
message	string	yes

WalletCompatFetchBalancesResponseDto

Type: object

Field	Type	Required	Description
status	boolean enum: true	yes
data	array<WalletCompatBalanceNodeResponseDto>	yes

WalletCompatHealthResponseDto

Type: object

Field	Type	Required	Description
status	boolean enum: true	yes
service	string	yes

WalletCompatPaginationMetaResponseDto

Type: object

Field	Type	Required	Description
page	number	yes
pages	number	yes
perPage	number	yes
total	number	yes

WalletCompatRegisteredResponseDto

Type: object

Field	Type	Required	Description
exists	boolean	yes
walletAlias	string nullable	yes

WalletCompatResultEnvelopeResponseDto

Type: object

Field	Type	Required	Description
data	oneOf: string nullable | number | boolean | object | array<>	no
status	number	yes
error	boolean	yes
message	string	no
stale	boolean	no
balancesAvailable	boolean enum: false	no

WalletCompatSignatureResponseDto

Type: object

Field	Type	Required	Description
status	boolean enum: true	yes
signature	string	yes

WalletCompatStatusResponseDto

Type: object

Field	Type	Required	Description
data	oneOf: string nullable | number | boolean | object | array<>	no
status	boolean	yes
message	string	no
meta	WalletCompatPaginationMetaResponseDto	no
token	string	no
refreshToken	string	no
tx_hash	string nullable	no
signature	string	no
balancesAvailable	boolean enum: false	no

WalletCompatSuccessResponseDto

Type: object

Field	Type	Required	Description
data	oneOf: string nullable | number | boolean | object | array<>	no
success	boolean	yes
message	string	no

WalletCompatTransactionRowResponseDto

Type: object

Field	Type	Required	Description
Method	string	yes
FromWallet	string	yes
ToWallet	string	yes
Amount	string	yes
CreatedAt	string	yes
TransactionHash	string	yes

WalletCompatTransactionsResponseDto

Type: object

Field	Type	Required	Description
status	boolean enum: true	yes
data	array<WalletCompatTransactionRowResponseDto>	yes

WhatsNewResponseDto

Type: object

Field	Type	Required	Description
active	boolean	yes
id	string nullable	yes
title	string nullable	yes
message	string nullable	yes
url	string nullable	yes
updatedAt	string nullable	yes