ChainVine API Docs
  • Chainvine
    • Product and Features
    • Technical Overview
  • ⚙️Developers
    • 🔨Use Cases
      • Leverage cookies
      • Link Claimer/Referrer
      • Record Link Click
      • Generate a Referrer Link
      • Record a Transfer Event
      • Complete a Requirement
    • 🖼️Embedded Widget
      • Implementation
      • FAQ
    • 🧰SDK
      • Implementation
      • Configuring the Client
      • Classes and Functions
        • Utility Methods
        • ChainvineClient
          • getReferralUrl(walletAddress)
          • recordClick(referrer)
          • linkReferrer([payload,])
          • referralConversion([payload,])
          • syncUser(walletAddress)
          • getCampaignReferralStats([payload,])
        • ChainvineUser
          • Initializing the client
          • joinCampaign([campaignParams,])
          • getRequirement([payload,])
          • getUserStats([payload,])
          • verifyRequirement([payload,])
          • completeRequirement([payload,])
          • claimEligibleEarnings([payload,])
          • transferEvent([payload,])
          • referral([campaignParams,])
            • linkToReferrer(referrer)
            • url()
          • setRewardTiersOverride([payload,])
        • Errors
        • Authentication
          • Getting your API Key
          • Allow-listing a domain
      • FAQ
    • 🪝Webhooks
    • 📔Open API Specification
  • Rewards
    • Claiming For Users
      • On ChainVine
Powered by GitBook
On this page
  • Params
  • Response
  1. Developers
  2. SDK
  3. Classes and Functions
  4. ChainvineClient

getReferralUrl(walletAddress)

Retrieves the referral URL for a given wallet address.

PreviousChainvineClientNextrecordClick(referrer)

Last updated 1 year ago

To be deprecated

This method will be deprecated in upcoming versions of the SDK. Please use the method instead.

Params

Param
Required
Description

walletAddress

required

the wallet of the user to general a referral link for

Response

ReferralUrlResponse

Type
Description

url

String

the referral URL for the given wallet address

wallet_address

String

the wallet address linked to the referral URL

new_user

Boolean

indicates whether the supplied wallet address is a new user

⚙️
🧰
ChainvineUser.referral.url