For the complete documentation index, see llms.txt. This page is also available as Markdown.

πŸ› οΈConfiguration parameters

The Widget Customizer is the preferred way to configure a widget. These URL parameters are available for programmatic integrations.

Core parameters

Parameter
Type
Description

publicKey

string

Required widget public key. Prefix determines sandbox or production.

operationMode

enum

buy, sell, or buy_sell. Defaults to buy.

region

string

Region letter_id used to preselect a country, state, or province.

Transaction defaults

Parameter
Type
Description

defaultAsset

string

Asset letter_id, for example bitcoin.

defaultNetwork

string

Network code, for example bitcoin or ethereum.

defaultFiat

string

Fiat code, for example USD or EUR.

defaultFiatAmount

number

Initial fiat amount for a buy.

defaultCryptoAmount

number

Initial crypto amount, primarily for a sell.

defaultPaymentMethod

string

Payment-method letter_id.

lockDefaultAsset

boolean

When true, prevents the user from changing the selected asset.

walletAddress

string

Wallet address for the selected default network.

wallets

string

Comma-separated network:address entries.

Example with defaults:

https://widget.coindisco.com/?publicKey=pk_test_YOUR_PUBLIC_KEY&operationMode=buy&defaultAsset=ethereum&defaultNetwork=ethereum&defaultFiat=USD&defaultFiatAmount=250

Example with multiple wallets:

Availability filters

Values are comma-separated identifiers.

Parameter
Description

supportedNetworks

Restrict available networks by network code.

activeProviders

Restrict the widget to selected provider identifiers.

includeCrypto

Show only selected asset letter_id values.

excludeCrypto

Hide selected asset letter_id values.

includeFiats

Show only selected fiat codes.

excludeFiats

Hide selected fiat codes.

includePaymentMethods

Show only selected payment-method identifiers.

excludePaymentMethods

Hide selected payment-method identifiers.

Avoid setting both include and exclude parameters for the same resource. The selected default must remain available after filters are applied.

Theme and borders

Parameter
Values

theme

catpuccinoDark, catpuccinoLight, dark, light, cyberpunk, retro

borders

small, default, soft, rounded

Custom color values are hexadecimal strings without #.

Parameter
Parameter
Parameter

backgroundCard

backgroundColor

borderColor

buttonBackground

errorColor

focusColor

hoverColor

iconsColor

invertTextColor

secondTextColor

skeletonGradientFrom

skeletonGradientTo

successColor

textColor

Last updated