🎍API
ShareMint API documentation
Fetch a project user
GET https://sharemint.xyz/api/external/user
Query Parameters
slug*
String
Project slug
address*
String
User address or email
chain*
String
Blockchain name
apiSecret
String
Your secret API key from the project admin page
Get user address from invite code
GET https://sharemint.xyz/api/external/address-from-invite-code
Query Parameters
code*
String
User's referral code
slug*
String
Project slug
Get affiliate details
GET https://sharemint.xyz/api/external/affiliate
One of address, projectUserId, or referralCode is required.
Query Parameters
address
String
Affiliate's wallet address
projectUserId
String
Affiliate's id in project
referralCode
String
Affiliate's referral code
slug*
String
Project slug
apiSecret
String
Your secret API key from the project admin page
Get invite code
POST https://sharemint.xyz/api/external/get-or-create-invite-code
Get an affiliate's invite code. Create it if it doesn't exist.
Request Body
address*
String
User's address
chain*
String
Blockchain name
slug*
String
Project slug
Save a referral via referral id or wallet address
POST https://sharemint.xyz/api/external/save
One of address, email, or transactionHash is required.
Request Body
slug*
String
Project slug
invitedById
String
The invite code of the referrer that invited the user
invitedByAddress
String
The address of the referrer that invited the user
address
String
User's wallet address
String
User's email
transactionHash
String
Transaction hash
chain
String
Chain
minter
String
One of "payer" or "receiver"
apiSecret
String
Your secret API key from the project admin page
verified
Boolean
If the referral is verified. Can only be set when providing an apiSecret
disqualifiedAsReferee
Boolean
If the user is disqualified from being a referee. Can only be set when providing an apiSecret. This field has no impact if the user has already been referred by someone.
Save a referral via a transaction hash
POST https://sharemint.xyz/api/external/save-transaction
This saves both the referral and the payment made in the transaction.
Request Body
slug*
String
Project slug
String
User's email
minter*
String
One of "payer" or "receiver"
transactionHash*
String
Transaction hash
chain
String
Chain
invitedById*
String
The invite code of the referrer that invited the user
invitedByAddress
String
The address of the referrer that invited the user
apiSecret
String
Your secret API key from the project admin page
verified
Boolean
Is the user verified?
Save an event
POST https://sharemint.xyz/api/external/save-event
One of address, email, or projectUserId is required.
Request Body
slug*
String
Project slug
apiSecret*
String
Your secret API key from the project admin page
name*
String
Name of the event that you set in the project settings
value
Number
Value of the event
address
String
User's address
String
User's email
projectUserId
String
User's id on ShareMint for this project
referredByCode
String
The invite code of the referrer that invited the user
referredByAddress
String
The address of the referrer that invited the user
Save payment
POST https://sharemint.xyz/api/external/save-payment
One of address or email is required.
Request Body
slug*
String
Project slug
apiSecret*
String
Your secret API key from the project admin page
invitedById*
String
Referrer's id
value*
String
Payment value. Must be bigger than 0
invitedByAddress
String
Referrer's address
quantity
String
Amount of purchases
chain
String
Blockchain name. Can be "FIAT", "ETHEREUM", "POLYGON", "ARBITRUM", "OPTIMISM", "SOLANA", "GOERLI", "SEPOLIA"
address
String
User's address
String
User's email
Last updated