🖼️
Teller Widget
  • Overview
  • Getting started
  • API Reference
  • Teller Protocol Documentation
  • Generating subgraph studio api key
Powered by GitBook
On this page

API Reference

PreviousGetting startedNextGenerating subgraph studio api key

Last updated 7 months ago

Prop name
Prop type
Default value
Information

subgraphApiKey

string

*required*

Please refer to this for generating an api key

buttonLabel

string

Cash advance

Label to display on the widget button

whitelistedTokens

{ [chainId: number]: string[] }

undefined

By default, Tokens to show additionally to the one in the user's wallet. If paired with showOnlyWhitelistedTokens these are the only displayed tokens

showOnlyWhitelistedTokens

boolean

false

Toggle to show only the tokens defined in whitelistedTokens

buttonClassName

string

undefined

A css class name to pass to the button

isBareButton

boolean

false

An additional styling prop to remove all styles to the button

whitelistedChains

array

undefined

An array of chain ids to show in the chain dropdown. Available values : 1,137, 42161, 8453

referralFee

number

0

Referral fee %, in basis points. Ie 100 = 1%.

Max 500 = 5%.

referralAddress

string

0x193C83873843CA7a170490d3752BCcB678365d57

Recipient wallet address to receive referral fee.

welcomeScreenLogo

string

undefined

Logo (as URL) displayed on the widget's welcome screen. Image types .png, .jpg, .jpeg, .svg.

welcomeScreenTitle

string

undefined

Bold, header text on the widget's welcome screen.

welcomeScreenParagraph

string

undefined

Body, paragraph text on the widget's welcome screen.

guide