Документация по API

Аутентификация

Для использования Foundico API шлюза вам необходимо иметь оба ключа: Публичный и Приватный. Все запросы должны быть подписаны приватным ключом и отправлены POST методом.

PHP пример аутентификации

$privateKey = 'privateKey';
$publicKey = 'publicKey';

$parameters = array('status' => 'upcoming');
$postData = json_encode($parameters);
$accessKey = base64_encode(hash_hmac('sha256', $postData, $privateKey, true));

$ch = curl_init('https://foundico.com/api/v1/icos/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
	'Content-Type: application/json',
	'X-Foundico-Public-Key: '.$publicKey,
	'X-Foundico-Access-Key: '.$accessKey
]);

$response = curl_exec($ch);
curl_close($ch);
echo $response;

ICO - Фильтры

/filters/

Конечная точка возвращает все доступные ICO фильтры.

Запрос

POST https://foundico.com/api/v1/filters/

Параметры

Параметры отсутствуют.

Ответ

{
"platform": [
	{
		"id": "158",
		"name": "Ardor"
	},
	// ...
],
"category": [
	{
		"id": "27",
		"name": "Adult"
	},
	// ...
],
"type": [
	{
		"id": "44",
		"name": "ICO"
	},
	// ...
],
"location": [
	{
		"name": "Albania"
	},
	// ...
]
}

Имя	Тип	Описание
platform	object[]	Список всех доступных платформ.
platform[n].id	int	ID текущей платформы.
platform[n].name	string	Имя текущей платформы.
category	object[]	Список всех доступных категорий.
category[n].id	int	ID текущей категории.
category[n].name	string	Имя текущей категории.
type	object[]	Список всех доступных типов ICO.
type[n].id	int	ID текущего типа.
type[n].name	string	Имя текущего типа.
location	object[]	Список всех доступных стран.
location[n].name	string	Название текущей страны.

ICO - Все

/icos/

Конечная точка возвращает до 20 ICO проектов на страницу с количеством страниц, зависимым от параметров фильтра.

Запрос

POST https://foundico.com/api/v1/icos/

PHP пример составления параметров запроса

$parameters = array(
	'sort_asc' => 'name',
	'platform' => array(111),
	'category' => array(27, 28, 90),
	'status' => 'upcoming',
	'ico_score' => 7,
	'location' => array('China', 'Malta'),
	'investor_wl' => 'yes',
	'accepted_currencies' => array('ETH', 'BTC', 'LTC'),
	// ...
);

Параметры

Имя	Тип	Значения	Описание
sort_asc	string	-name -id -start_datetime -end_datetime	Сортирует ICO в ответе API по возрастанию указанного значения.
sort_desc	string	-name -id -start_datetime -end_datetime	Сортирует ICO в ответе API по убыванию указанного значения.
page	int	номер страницы	Выводит ICO с указанной страницы.
platform	array of int values	ID платформ	Выводит ICO с указанной платформой.
category	array of int values	ID категорий	Выводит ICO, размещенные в указанной категории.
type	array of int values	ID типов	Выводит ICO указанного типа.
location	array of string values	названия стран	Выводит ICO, размещенные в указанных странах.
status	string	-ongoing -upcoming -past	Выводит ICO, находящихся в указанном статусе.
ico_score	int	1-10	Выводит ICO, которые имеют ICO Score от 1+, 2+, 3+...
airdrop_program	string	-yes	Выводит ICO, которые имеют airdrop программу.
bounty_program	string	-yes	Выводит ICO, которые имеют bounty программу.
investor_kyc	string	-yes	Выводит ICO, которые проводят KYC процедуру.
investor_wl	string	-yes	Выводит ICO, которые ведут whitelist.
ico_kyc_passed	string	-yes	Выводит ICO, команда которых прошла KYC процедуру.
accepted_currencies	array of string values	коды валют	Выводит ICO, которые принимают указанные валюты.
exclude_areas	array of string values	названия стран	Выводит ICO, исключая те, которые запрещены в указанных странах.

Ответ

{
"total_icos": "2520",
"total_pages": 126,
"current_page": 1,
"error": null,
"data": [
	{
		"id": "16174",
		"main": {
			"name": "0xcert",
			"logo": "https:\/\/foundico.com\/upload\/iblock\/a6f\/a6ffaed2a580aa44cb92e7d417929f8a.png",
			"ico_score": "8"
		},
		"links": {
			"url": "https:\/\/foundico.com\/ico\/0xcert.html"
		},
		"finance": {
			"raised": ""
		}
	},
	// ...
]
}

Имя	Тип	Описание
total_icos	int	Полное количество ICO, найденных по текущим параметрам фильтра. Количество ограничено 20 ICO проектами на страницу.
total_pages	int	Полное количество страниц ICO проектов, найденных по текущим параметрам фильтра.
current_page	int	Номер текущей страницы.
error	int or null	Код ошибки текущего запроса.
data	object[]	Список ICO проектов, найденых по текущим параметрам фильтра.
data[n].id	int	ID текущего ICO.
data[n].main	object[]	Основная информация о текущем ICO.
data[n].main.name	string	Имя текущего ICO.
data[n].main.logo	string	Ссылка на логотип текущего ICO.
data[n].main.ico_score	string	ICO Score текущего ICO.
data[n].links	object[]	Ссылки, принадлежащие текущему ICO.
data[n].links.url	string	Ссылка на страницу текущего ICO на Foundico.com.
data[n].finance	object[]	Финансовая информация о текущем ICO.
data[n].finance.raised	int	Количество собранных средств в USD.

ICO - Профиль

/ico/

Конечная точка возвращает детальную информацию по запрашиваемому ICO проекту.

Запрос

POST https://foundico.com/api/v1/ico/

PHP пример составления параметров запроса

$parameters = array('id' => 16174);

Parameters

Имя	Тип	Значения	Описание
id	int	ID требуемого ICO	Выводит ICO с указанным ID.

Ответ

{
"error": null,
"data": {
	"id": "16174",
	"main": {
		"name": "0xcert",
		"description": "Create, own, and validate unique assets on the blockchain with 0xcert - the first open protocol built to support the future of digital assets, powered by non-fungible tokens.",
		"logo": "https:\/\/foundico.com\/upload\/iblock\/a6f\/a6ffaed2a580aa44cb92e7d417929f8a.png",
		"premium": "",
		"scam": "",
		"ico_score": "8.9",
		"platform": "Ethereum",
		"kyc": true,
		"whitelist": true,
		"category": "Computing",
		"type": "ICO",
		"mvp": true,
		"location": "Slovenia",
		"kyc_passed": true
	},
	"links": {
		"url": "https:\/\/foundico.com\/ico\/0xcert.html",
		"website": "https:\/\/0xcert.org\/",
		"whitepaper": "https:\/\/0xcert.org\/whitepaper.pdf",
		"social": {
			"twitter": "https:\/\/twitter.com\/0xcert",
			// ...
		},
		"video": "https:\/\/www.youtube.com\/watch?v=yptxQdD6Xbo"
	},
	"finance": {
		"ticker": "ZXC",
		"tokens_for_sale": "250000000",
		"token_price": "0.0073",
		"token_price_unit": "USD",
		"min_purchase": "",
		"max_purchase": "",
		"purchase_unit": "ZXC",
		"token_type": "ERC20",
		"soft_cap": "3000000",
		"hard_cap": "12000000",
		"caps_unit": "USD",
		"escrow": "",
		"markets": [
			"https:\/\/bittrex.com",
			// ...
		],
		"distribution": {
			"Development": "50%",
			// ...
		},
		"restricted_areas": "",
		"accepting": [
			"ETH",
			// ...
		],
		"raised": ""
	},
	"dates": {
		"start_datetime": "02.07.2018 17:00:00",
		"end_datetime": "18.07.2018 23:59:00",
		"tba": ""
	},
	"additional": {
		"bonuses": {
			"Private presale": "20-15%",
			// ...
		},
		"airdrop": "",
		"bounty": true
	},
	"roadmap": {
		"31-10-2017": "First proposal of the blockchain certification technology First MVP",
		// ...
	},
	"team": [
		{
			"name": "Jure Zih",
			"role": "0xcert CEO",
			"photo": "https:\/\/foundico.com\/upload\/iblock\/89f\/89f2816ccc27b9ab42ccbf323661da6f.PNG",
			"social": {
				"linkedin": "https:\/\/www.linkedin.com\/in\/jurezih\/",
				// ...
			}
		},
		// ...
	],
	"advisors": [
		{
			"name": "William Entriken",
			"role": "Lead Author of the ERC-721 Standard",
			"photo": "https:\/\/foundico.com\/upload\/iblock\/7b1\/7b1ac8d2c2047a6f515f5f6d40d88c7b.PNG",
			"social": {
				"linkedin": "https:\/\/www.linkedin.com\/in\/fulldecent",
				// ...
			}
		},
		// ...
	]
}
}

Имя	Тип	Описание
error	int or null	Код ошибки текущего запроса.
data	object[]	ICO для текущего запроса.
data.id	int	ID текущего ICO.
data.main	object[]	Основная информация об ICO.
data.main.name	string	Название ICO.
data.main.description	string	Текстовое описание ICO.
data.main.logo	string	Ссылка на логотип ICO.
data.main.premium	boolean	Возвращает "true" если ICO размещено как "премиум".
data.main.scam	boolean	Возвращает "true" если ICO помечено как мошенническое.
data.main.ico_score	float	ICO Score текущего ICO.
data.main.platform	string	Название платформы ICO.
data.main.kyc	boolean	Возвращает "true" если ICO проводит KYC процедуру.
data.main.whitelist	boolean	Возвращает "true" если ICO ведет whitelist.
data.main.category	string	Название категории, в которой размещено ICO.
data.main.type	string	Тип ICO.
data.main.mvp	boolean	Возвращает "true" если ICO имеет MVP.
data.main.location	string	Название страны, в которой размещено ICO.
data.main.kyc_passed	boolean	Возвращает "true" если команда ICO прошла KYC процедуру.
data.links	object[]	Ссылка на ресурсы и социальные сети ICO.
data.links.url	string	Ссылка на страницу ICO на Foundico.com.
data.links.website	string	Ссылка на официальный сайт.
data.links.whitepaper	string	Ссылка на whitepaper.
data.links.social	object	Ссылки на социальные сети.
data.links.social['n']	string	Ссылка на текущую социальную сеть.
data.links.video	string	Ссылка на видео презентацию.
data.finance	object[]	Финансовая инфомрация об ICO.
data.finance.ticker	string	Символьный код токена.
data.finance.tokens_for_sale	int	Количество токенов, доступных к продаже во время ICO.
data.finance.token_price	float	Цена токена. Во время ICO возвращает фиксированную цену. После завершения ICO возвращает актуальную цену с CoinMarketCap.
data.finance.token_price_unit	string	Единица в которой представлена цена токена.
data.finance.min_purchase	int or float	Минимальная сумма покупки.
data.finance.max_purchase	int or float	Максимальная сумма покупки.
data.finance.purchase_unit	string	Единица в которой представлены минимальная и максимальная суммы покупки.
data.finance.token_type	string	Тип токена (только для проектов, основанных на Ethereum).
data.finance.soft_cap	int or float	Softcap данного ICO. Может быть пустым.
data.finance.hard_cap	int or float	Hardcap данного ICO.
data.finance.caps_unit	string	Единица в которой представлены softcap и hardcap.
data.finance.escrow	boolean	Возвращает "true" если ICO имеет escrow.
data.finance.markets	array	Список бирж на которых планируется размещение токена.
data.finance.markets[n]	string	Ссылка на текущую биржу.
data.finance.distribution	object	Процентное распределение токенов во время ICO.
data.finance.distribution['n']	string	Процентное значение текущей статьи распределения токенов.
data.finance.restricted_areas	array	Список стран в которых запрещено ICO.
data.finance.restricted_areas[n]	array string	Название текущей страны.
data.finance.accepting	array	Список принимаемых валют во время ICO.
data.finance.accepting[n]	string	Символьный код текущей валюты, например "ETH".
data.dates	object[]	Даты начала и окончания текущей стадии.
data.dates.start_datetime	string DD.MM.YYYY HH:MM:SS	Дата и время начала.
data.dates.end_datetime	string DD.MM.YYYY HH:MM:SS	Дата и время окончания.
data.dates.tba	boolean	Возвращает "true" если даты начала и окончания не определены.
data.additional	object[]	Дополнительная информация об ICO.
data.additional.bonuses	object	Список бонусов, предоставляемых во время ICO.
data.additional.bonuses['n']	string	Условия текущего бонуса.
data.additional.airdrop	boolean	Возвращает "true" если ICO имеет airdrop программу.
data.additional.bounty	boolean	Возвращает "true" если ICO имеет bounty программу.
data.roadmap	object	Список этапов roadmap.
data.roadmap['n']	string	Описание текущего этапа.
data.team	object[]	Список участников команды ICO.
data.team[n].name	string	Имя текущего участника.
data.team[n].role	string	Роль текущего участника в проекте.
data.team[n].photo	string	Ссылка на фотографию текущего участника.
data.team[n].social	object	Ссылки на социальные сети текущего участника.
data.team[n].social['n']	string	Ссылка на текущую социальную сеть.
data.advisors	object[]	Список советников ICO.
data.advisors[n].name	string	Имя текущего советника.
data.advisors[n].role	string	Роль текущего советника в проекте.
data.advisors[n].photo	string	Ссылка на фотографию текущего советника.
data.advisors[n].social	object	Ссылки на социальные сети текущего советника.
data.advisors[n].social['n']	string	Ссылка на текущую социальную сеть.

Ошибки

Код ошибки	Описание
480	Неправильный приватный или публичный ключ. Пользователь должен включать приватный и публичный ключи в каждый запрос к Foundico API шлюзу.
481	Метод не существует. Пользователь запросил несуществующую конечную точку.
482	Проекты не найдены. Не найдено ни одного ICO по запрошенным параметрам фильтра.
483	Шлюз получил некорректное значение. Параметры запроса имеют некорректные символы.
484	Отсутствуют требуемые параметры. Запрос был отправлен без обязательных параметров.
485	За пределами лимитов. Вы превысили ваш дневной лимит запросов к API.