Safary API

Pro Feature, BETA.

Welcome to the first public release of Safary API. This REST API allows you to access diverse resources from https://api.safary.club. With a range of methods and endpoints at your disposal, you can manipulate and retrieve useful data with ease. It should be noted, however, that this is a beta release. As we continue to develop and refine our API, changes may occur, so your patience and understanding are most appreciated.

Versioning

Our API uses a versioning system to ensure its evolutivity. Each version is pathed; for example, the current version is v1. Hence, all methods are found behind the main URL as follows: https://api.safary.club/v1/{method-name}. This structure allows us to evolve the API while maintaining backwards compatibility.

Authentication

Authentication to our API is performed using API keys. To create your keys, you must first log in to your Safary account. Then, navigate to your settings and find the subheading labeled 'API keys'.

Include your API key in your API calls using the Authorization: Bearer {Your API key} HTTP header. Here is an example using curl:

curl -X GET 'https://api.safary.club/v1/{method-name}' \
-H 'Authorization: Bearer {your-api-key}'

Note: Replace the {method-name} placeholder with the actual method name (eg: websites, wallets) you want to access and replace {your-api-key} with your actual API key.

Pagination

All list endpoints in our API are paginated. List endpoints accept two pagination parameters: page and limit. Currently, the API can return a maximum of 100 elements at a time. However, this could change as we continue to develop and enhance the API.

Entities

Website

Field name	Data type	Comment
id	string
name	string / null
app_url	string / null
archived	boolean
industry	string / null
website_url	string
created_at	string	ISO8601 Date String
updated_at	Date	ISO8601 Date String

Wallet

Field name	Data type	Comment
address	string
balance	number	In USD
country	string	ISO3166 Country Code
source	string
connection_date	string	ISO8601 Date String

Event

Field	Type	Comment
id	string
product_id	string
session_id	string
date	string	ISO8601 Date String
type	string
name	string
json_payload	string	JSON string
amount_usd	number	Nullable, only available for specific event types.

Campaign

Property Name	Property Data Type	Description
id	string
kind	string	Identifies the type of campaign. Possible values: 'slise', 'hypelab', 'blockchain_ads', 'layer3', 'guildxyz', 'questn', 'zealy', 'link', 'galxe', 'intract', 'farcaster_frames_link'.
source	string
name	string
medium	string
content	string
target_url	string
code	string
created_at	date	ISO8601 Date String
updated_at	date	ISO8601 Date String
external_link	string

Wallet Activity

kind (activity variants)	Field	Type	Comment
visit	date	date	ISO8601 Date String
	url	string
wallet_connected	date	date	ISO8601 Date String
	address	string
	type	string
	chain	string
chain_changed	date	date	ISO8601 Date String
	chain	string
swap	date	date	ISO8601 Date String
	event	string
	currencyFrom	string
	currencyTo	string
	amountUSD	number
deposit	date	date	ISO8601 Date String
	event	string
	currency	string
	amountUSD	number
withdrawal	date	date	ISO8601 Date String
	event	string
	currency	string
	amountUSD	number
event	activity	string
	date	date	ISO8601 Date String
	event	string
other	activity	string
	date	date

Websites

The /websites endpoint provides access to website-related resources.

• GET /websites: Returns a list of websites associated with your project. The list is paginated and supports the parameters page and limit.

• GET /websites/{websiteId}: This method returns the details for a single website. Replace {websiteId} with the ID of the specific website you are interested in.

Events

The /events endpoint provides access to custom events related to specific websites.

• GET /events: This endpoint returns a list of custom events tied to a website. The list is paginated and supports the parameters page and limit. When using this endpoint, make sure to format your URL and endpoint like this: /events?websiteId={your_website_id}. Replace {your_website_id} with your specific website's ID

• GET /events/:eventId: This method returns details of a specific event related to a website. Include a query param for the specific website. method returns the details for a single website. When using this endpoint, make sure to format your URL and endpoint like this: /events/:eventId?websiteId={your_website_id}. Replace :eventId with the specific event id you want to check and {your_website_id} with your specific website's ID

Wallets

The /wallets endpoint provides information about crypto wallets associated to your service. This endpoint requires you to pass a websiteId as a query parameter to identify the specific website for which you wish to retrieve the wallets.

• GET /wallets: Returns a list of wallets associated to your service. The list is paginated and supports the parameters page and limit. When using this endpoint, make sure to format your URL and endpoint like this: /wallets?websiteId={your_website_id}. Replace {your_website_id} with your specific website's ID

• GET /wallets/:address: Returns the details of an specific wallet associated with your website. When using this endpoint, make sure to format your URL and endpoint like this: /wallets/:address?websiteId={your_website_id}. Replace :address with the specific wallet address tou want to check and {your_website_id} with your specific website's ID

• GET /wallets/:address/related: Returns other wallets associated with the user of the original wallet. The list is paginated and supports the parameters page and limit. When using this endpoint, make sure to format your URL and endpoint like this: /wallets/:address/related?websiteId={your_website_id}. Replace :address with the specific wallet address tou want to check and {your_website_id} with your specific website's ID

• GET /wallets/:address/activity: Returns all of the activity related to an specific wallet. The list is paginated and supports the parameters page and limit. When using this endpoint, make sure to format your URL and endpoint like this: /wallets/:address/activity?websiteId={your_website_id}. Replace :address with the specific wallet address tou want to check and {your_website_id} with your specific website's ID

Campaigns

The /campaigns endpoint provides information and actions related to marketing campaigns in your product. This endpoint requires you to pass a websiteId as a query parameter to identify the specific website for which you wish to retrieve or manipulate campaign data.

Endpoints:

• GET /campaigns: Returns a list of campaigns. The list is paginated and supports the parameters page and limit. When using this endpoint, make sure to format your URL like this: /campaigns?websiteId={your_website_id}. Replace {your_website_id} with your specific website's ID.

• GET /campaigns/:id: Returns the details of a specific campaign. When using this endpoint, make sure to format your URL like this: /campaigns/:campaignId?websiteId={your_website_id}. Replace :campaignId with the specific campaign ID you want to retrieve and {your_website_id} with your specific website's ID.

• POST /campaigns: Creates a new campaign. You need to pass the details in the request body according to the campaign schema below. When using this endpoint, format your URL like this: /campaigns?websiteId={your_website_id}.

• DELETE /campaigns/:id: Deletes a specific campaign by its ID. When using this endpoint, format your URL like this: /campaigns/:campaignId?websiteId={your_website_id}. Replace :campaignId with the specific campaign ID you want to delete and {your_website_id} with your specific website's ID.

Create Campaign Request Body Schema

Below is a table describing the parameters required in the request body for creating different types of campaigns.

Field	Type	Description	Required
kind	string	Identifies the type of campaign. Possible values: 'slise', 'hypelab', 'blockchain_ads', 'layer3', 'guildxyz', 'questn', 'zealy', 'link', 'galxe', 'intract', 'farcaster_frames_link'.	Yes
source	string	Source of the campaign (1-100 chars).	Yes
name	string	Name of the campaign (1-100 chars).	Yes
targetUrl	string	URL targeted by the campaign. Must be a valid URL.	Yes
medium	string	(Optional) Medium of the campaign. Only required for 'link' kind.	No
content	string	(Optional) Content of the campaign. Only required for 'link' kind.	No