Overview

Welcome to the Coinschedule API! You can use our API to get information on the projects listed in Coinschedule.

Important! Before you start you need to request an API key using the API Access Form

You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

API Index

Overview

API Calls are made to the following URI.

https://api.coinschedule.com/api/v1

Authentication

Coinschedule uses API keys for authentication.

If you haven't already, you can request an API key on our API Access Form.

Your API key must be included in the Authentication-Info header of every request!

Errors

Coinschedule API endpoints return errors from 2xx to 5xx, in the JSON response body a code and an error will be returned.

The code in the JSON response body is a basic HTTP code. You can view code meanings in the dark area to the right.

Attributes
  • code

    Contains one of the codes in the dark right of the page.

  • error-type

    The type of error returned. Can be: server_error, api_error, authentication_error, random_error, invalid_request_error, or rate_limit_error.

  • blocked

    Contains a boolean, if True your IP has been temp blocked.

  • error-messageoptional

    Contains an indepth error-message.

Codes
200 Everythings good!
400 Your request sucks!
401 Invalid API Key
402
404 Method doesn't exist on server
409 Possible user error
429 Your API key has reached it's hourly call limit
500, 502, 503, 504 Errors occured within the server
Errors
Types
server_error Returned when an internal server error has been thrown
api_error Child of server_error
authentication_error Invalid or malformed API key/JSON Web Token
random_error Unsure of what happened
invalid_request_error Malformed request body or Malformed URI
rate_limit_error API call limit has been reached

Handling Errors

If your request returns a 409 HTTP code we reccomend double checking your code and uploading your POST body to a JSON Validator. If issues persist create an issue on our issue tracker and we will assist you in locating and fixing your issue!

No data

Endpoints

Coinschedule has multiple endpoints allowing you to access upcoming and live ICOs, as well as get details of an ICO.

Remember

  • You must authenticate before attempting to access endpoints!
  • All requests must be sent over HTTPS, any HTTP requests will return a invalid_request_error

All base resource URL's are https://api.coinschedule.com/api/v1/

POST ico/live

Returns live ICO's within specified parameters.

Resource Information

Resource URI: https://api.coinschedule.com/api/v1/ico/live
Rate Limited: Yes
Requests / Per-Hour: 15
Response Format: JSON

Fields

Name Required Description Example
filters Yes! list of ICO filters {"filters":{"cat":[],"plat":[]}}
filters.cat Yes! list of category filters {"cat":["1","2","3"]}
filters.plat Yes! list of platinum filters {"plat":["1","2","3"]}
											
curl -d '{"filters":{"plat":[1],"cat":[1]}}' -H "Content-Type: application/json" -H "Authentication-Info: Basic key" -X POST https://api.coinschedule.com/api/v1/ico/live
											
										

The request returns formatted JSON similar to what's shown below.

									
{
	"code":200,
	"errors":[],
	"output":{
	"1099":{
		"EventID":"1099",
		"EventName":"Bitether ICO",
		"EventStartDate":"2017-09-18 00:01:00",
		"EventEndDate":"2042-03-17 00:00:00",
		"ProjSymbol":"BTR",
		"EventProjID":"1642"
	},
	"1378":{
		"EventID":"1378",
		"EventName":"ExMachina Coin ICO",
		"EventStartDate":"2017-10-17 12:00:00",
		"EventEndDate":"2017-12-31 12:00:00",
		"ProjSymbol":"EX Machina",
		"EventProjID":"1813"
	}
	},
	"method":"getLive",
	"filters":null
}
									
									
											
$params = ['filters' => ['cat' => [1], 'plat' => [1]]];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.coinschedule.com/api/v1/ico/live/");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
//curl_setopt(CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
	"Content-Type: application/json",
	"Authentication-Info: Basic key"
]);
/**@var string*/
$res = curl_exec($ch);
											
										

The request returns formatted JSON similar to what's shown below.

									
{
	"code":200,
	"errors":[

	],
	"output":{
	   "1099":{
	      "EventID":"1099",
	      "EventName":"Bitether ICO",
	      "EventStartDate":"2017-09-18 00:01:00",
	      "EventEndDate":"2042-03-17 00:00:00",
	      "ProjSymbol":"BTR",
	      "EventProjID":"1642"
	   },
	   "1378":{
	      "EventID":"1378",
	      "EventName":"ExMachina Coin ICO",
	      "EventStartDate":"2017-10-17 12:00:00",
	      "EventEndDate":"2017-12-31 12:00:00",
	      "ProjSymbol":"EX Machina",
	      "EventProjID":"1813"
	   }
	},
	"method":"getLive",
	"filters":null
}
									
									

POST /ico/upcoming

Returns upcoming ICO's within specified parameters.

Resource Information

Resource URI: https://api.coinschedule.com/api/v1/ico/upcoming
Rate Limited: Yes
Requests / Per-Hour: 15
Response Format: JSON

Fields

Name Required Description Example
filters Yes! list of ICO filters {"filters":{"cat":[],"plat":[]}}
filters.cat Yes! list of category filters {"cat":["1","2","3"]}
filters.plat Yes! list of platinum filters {"plat":["1","2","3"]}
											
curl -d '{"filters":{"plat":[1],"cat":[1]}}' -H "Content-Type: application/json" -H "Authentication-Info: Basic key" -X POST https://api.coinschedule.com/api/v1/ico/upcoming
											
										

The ico/upcoming request returns formatted JSON similar to what's shown below.

										
{
"code":200,
	"errors":[],
	"output":{
		"1099":{
		"EventID":"1099",
		"EventName":"Bitether ICO",
		"EventStartDate":"2017-09-18 00:01:00",
		"EventEndDate":"2042-03-17 00:00:00",
		"ProjSymbol":"BTR",
		"EventProjID":"1642"
		},
		"1378":{
		"EventID":"1378",
		"EventName":"ExMachina Coin ICO",
		"EventStartDate":"2017-10-17 12:00:00",
		"EventEndDate":"2017-12-31 12:00:00",
		"ProjSymbol":"EX Machina",
		"EventProjID":"1813"
		}
	},
	"method":"getUpcoming",
	"filters":null
}
										
									
											
$params = ['filters' => ['cat' => [1], 'plat' => [1]]];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.coinschedule.com/api/v1/ico/upcoming/");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
//curl_setopt(CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
	"Content-Type: application/json",
	"Authentication-Info: Basic key"
]);
/**@var string*/
$res = curl_exec($ch);
											
										

The ico/upcoming request returns formatted JSON similar to what's shown below.

									
{
	"code":200,
	"output":{
		"1099":{
			"EventID":"1099",
			"EventName":"Bitether ICO",
			"EventStartDate":"2017-09-18 00:01:00",
			"EventEndDate":"2042-03-17 00:00:00",
			"ProjSymbol":"BTR",
			"EventProjID":"1642"
		},
		"1378":{
			"EventID":"1378",
			"EventName":"ExMachina Coin ICO",
			"EventStartDate":"2017-10-17 12:00:00",
			"EventEndDate":"2017-12-31 12:00:00",
			"ProjSymbol":"EX Machina",
			"EventProjID":"1813"
		}
	}
}
									
									

POST /ico/details/eventid:projectid

Returns an ICO's details based on parameters.

Resource Information

Resource URI: https://api.coinschedule.com/api/v1//ico/details/eventid:projectid
Rate Limited: Yes
Requests / Per-Hour: 15
Response Format: JSON

Fields

No POST Parameters!

											
curl -d '{"filters":{"plat":[1],"cat":[1]}}' -H "Content-Type: application/json" -H "Authentication-Info: Basic key" -X POST -d '{}' https://api.coinschedule.com/api/v1/ico/details/1:1
											
										

projectid and eventid are formatted as shown eventid:projectid. null can be passed as an event/project id.

The ico/details request returns formatted JSON similar to what's shown below.

									
{
	"code": 200,
	"output": {
		"ProjID": "718",
		"ProjName": "Chronobank",
		"ProjSymbol": "TIME",
		"ProjDesc": "ChronoBank.io is an ambitious and wide-ranging blockchain project, aimed at disrupting the HR/recruitment/finance industries in a similar way to how Uber disrupted the taxi business and how Upwork represented an evolution in freelancing.",
		"ProjType": "1",
		"ProjSponsored": "0",
		"ProjLocation": null,
		"ProjAlgo": "",
		"ProjTotalSupp": "710113.0",
		"ProjTotalSuppNote": "",
		"ProjPreMined": "0.0",
		"ProjPreMinedNote": "",
		"EventName": "ChronoBank ICO",
		"EventID": "1",
		"EventURL": "https:/coinschedule.com/icos/e1/chronobank-ico.html"
	}
}
									
									
											
$eventid = 274;
$projectid = null;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.coinschedule.com/api/v1/ico/detaild/{$eventid}:{$projectid}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
	"Content-Type: application/json",
	"Authentication-Info: Basic key"
]);
/**@var string*/
$res = curl_exec($ch);
											
										

projectid and eventid are formatted as shown eventid:projectid. null can be passed as an event/project id.

The ico/details request returns formatted JSON similar to what's shown below.

									
{
	"code": 200,
	"output": {
		"ProjID": "718",
		"ProjName": "Chronobank",
		"ProjSymbol": "TIME",
		"ProjDesc": "ChronoBank.io is an ambitious and wide-ranging blockchain project, aimed at disrupting the HR/recruitment/finance industries in a similar way to how Uber disrupted the taxi business and how Upwork represented an evolution in freelancing.",
		"ProjType": "1",
		"ProjSponsored": "0",
		"ProjLocation": null,
		"ProjAlgo": "",
		"ProjTotalSupp": "710113.0",
		"ProjTotalSuppNote": "",
		"ProjPreMined": "0.0",
		"ProjPreMinedNote": "",
		"EventName": "ChronoBank ICO",
		"EventID": "1",
		"EventURL": "https:/coinschedule.com/icos/e1/chronobank-ico.html"
	}
}
									
									

POST filters/categories

Returns all categories.

Resource Information

Resource URI: https://api.coinschedule.com/api/v1/filters/categories
Rate Limited: Yes
Requests / Per-Hour: 15
Response Format: JSON

Fields

No Parameters!
											
											
curl -H "Authentication-Info: Basic key" -X POST -d '{}' https://api.coinschedule.com/api/v1/filters/categories
					
											
										

The filters/categories request returns formatted JSON similar to what's shown below. If using a language binding the JSON will be decoded and the call will return a multi-dimensional list.

									
No Data Avalible
									
									
											
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.coinschedule.com/api/v1/filters/categories");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
	"Authentication-Info: Basic DC18223E14B98D35"
]);
/**@var string*/
$res = curl_exec($ch);
											
										

The ico/categories request returns formatted JSON similar to what's shown below.

									
No Data Avalible
									
									

GET filters/platform

Returns all platform filters.

Resource Information

Resource URI: https://api.coinschedule.com/api/v1/filter/platform
Rate Limited: Yes
Requests / Per-Hour: 15
Response Format: JSON

Fields

No Parameters!
											
curl -H "Authentication-Info: Basic key" -X POST -d '{}' https://api.coinschedule.com/api/v1/filters/platform
											
										

The filters/platform request returns formatted JSON similar to what's shown below.

									
No Data Avalible
									
									
											
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.coinschedule.com/api/v1/filters/platform");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
	"Authentication-Info: Basic DC18223E14B98D35"
]);
/**@var string*/
$res = curl_exec($ch);
											
										

The filters/platform request returns formatted JSON similar to what's shown below.

									
No Data Avalible