📔Open API Specification

Context

Here you will find our OpenAPI specification for the Chainvine API.

All endpoints below require you to provide your api key in the headers

{
    'X-API-KEY': 'your-api-key'
}

SyncUser

Always call this method early on in your flows to fetch a user's Chainvine ID.

Note: the SDK handles calling this endpoint for your when using the SDK to call the methods in the ChainvineUser section.

Creates or updates a user, and returns the user's details. Use this method to get your user's Chainvine ID to use the methods bellow.

post

/api/v2/users

Authorizations

Body

chain_idstring

emailstring

external_idstring

firstNamestring

lastNamestring

networkstring

wallet_addressstring

user_typestring · default: walletrequired

Pattern: ^(wallet|email|externalId)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.chainvine.xyz/api/v2/users' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "chain_id": "text",
    "email": "text",
    "external_id": "text",
    "firstName": "text",
    "lastName": "text",
    "network": "text",
    "wallet_address": "text",
    "user_type": "wallet"
  }'

200

400

500

200

{
  "id": "text"
}

User created successfully

This endpoint can also be used to update the user's information.

ChainvineUser

These endpoints can also be covered via the SDK. Please see methods outlined there as needed or examples of how to use these endpoints to suit your needs.

Create a referral between a referrer and claimer

Create a referral between a referrer and a claimer

post

/api/v2/user/{user_id}/campaign/{campaign_id}/link/referral

Authorizations

Path parameters

user_idstringrequired

campaign_idstringrequired

The campaign id you want to create a referral in

Body

campaign_idstring · slugrequired

The campaign id you want to create a referral in

Example: joidj2odkd

referrerstring · uuidrequired

The referring user's Chainvine Id, obtained via the referral link r parameter

Example: fjdopwdp2pmosjo2ds

wallet_addressstringrequired

Example: 0x03jkd0ij2od

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/link/referral' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "campaign_id": "joidj2odkd",
    "referrer": "fjdopwdp2pmosjo2ds",
    "wallet_address": "0x03jkd0ij2od"
  }'

200

400

200

No body

OK

Get the referral url for your user

Generates your user's referral url for the program id provided

get

/api/v2/user/{user_id}/campaign/{campaign_id}/referral/url

Authorizations

Path parameters

user_idstringrequired

campaign_idstringrequired

The campaign id you want to generate a referral url for

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/referral/url' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

400

200

No body

OK

Handle a transfer event

Send a custom transfer event with a monetary payload to apply to credit as a reward to the referrer who referrer the user

post

/api/v2/user/{user_id}/campaign/{campaign_id}/events/transfer

Authorizations

Path parameters

user_idstringrequired

campaign_idstringrequired

The campaign id you want to generate a transfer event in

Body

amountnumberrequired

Example: 12443.43

requirement_idstring

Example: anId123

external_identifierstring

Example: Ok

feenumber

Example: 134.32

token_addressstring

Example: Ok

transaction_hashstring

Example: Ok

usd_valuenumber

Example: 134.32

user_idstring

Example: Ok

wallet_addressstring

Example: Ok

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/events/transfer' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 12443.43,
    "requirement_id": "anId123",
    "external_identifier": "Ok",
    "fee": 134.32,
    "token_address": "Ok",
    "transaction_hash": "Ok",
    "usd_value": 134.32,
    "user_id": "Ok",
    "wallet_address": "Ok"
  }'

200

400

200

{
  "amount": 12443.43,
  "requirement_id": "anId123",
  "external_identifier": "Ok",
  "fee": 134.32,
  "token_address": "Ok",
  "transaction_hash": "Ok",
  "usd_value": 134.32,
  "user_id": "Ok",
  "wallet_address": "Ok"
}

Event handled successfully

Mark a requirement as complete

Completes a requirement for a user within a referral program/campaign

https://docs.chainvine.xyz/technical/sdk/use-cases/requirements/completing-a-requirement-for-a-user

post

/api/v2/user/{user_id}/requirements/complete

Authorizations

Path parameters

user_idstringrequired

Body

campaignobjectrequired

idstring · slugrequired

The id of the requirement your wish to complete for the user

Example: d0djj9dj9dj0jk

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.chainvine.xyz/api/v2/user/{user_id}/requirements/complete' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "campaign": {
      "id": "c5de90fe"
    },
    "id": "d0djj9dj9dj0jk"
  }'

200

400

401

200

{
  "message": "Ok"
}

Referral was successfully registered

V1 Endpoints

Record a link click

Records a click on a user's referral URL

post

/v1/chainvine/community/{community_id}/campaign/{campaign_id}/record-click

Authorizations

Path parameters

community_idstringrequired

campaign_idstringrequired

The campaign id to track the link click against

Query parameters

referrerstringrequired

The referrer's referral code (found in the URL)

Body

campaign_idstring · slugrequired

The campaign id you want to create a referral in

Example: joidj2odkd

referrerstring · uuidrequired

The referring user's Chainvine Id, obtained via the referral link r parameter

Example: fjdopwdp2pmosjo2ds

wallet_addressstringrequired

Example: 0x03jkd0ij2od

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.chainvine.xyz/v1/chainvine/community/{community_id}/campaign/{campaign_id}/record-click?referrer=text' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "campaign_id": "joidj2odkd",
    "referrer": "fjdopwdp2pmosjo2ds",
    "wallet_address": "0x03jkd0ij2od"
  }'

200

400

401

200

No body

Link click was tracked

CodeGeneration

If you would like to generate custom code for the endpoints above, please visit our swaggerhub page and select the "Export" drop down at the top right of the page.