{"info":{"_postman_id":"9601f146-73d7-7912-0436-4e100162afb6","name":"DreamCoin API","description":"

Introduction

The DreamCoin API allows front-end clients to retrieve data about the user accounts, trades, and portfolios, as well as public coin data.

Overview

This API is under development.

Authentication

We use JSON Web Tokens to authenticate users.

Error Codes

TBD. You can expect HTTP status codes with error messages for some cases.

Rate limit

We're likely to host this on a free tier. Please be gentle.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"2759449","collectionId":"9601f146-73d7-7912-0436-4e100162afb6","publishedId":"RVnZfx7D","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-04-06T18:25:33.000Z"},"item":[{"name":"/coin-index","id":"c7baf0dd-20bf-7d80-3b1a-b08ec5ae8451","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/coin-index","description":"

Coin Index

This endpoint delivers a sorted list of all available coins.

Path Parameters

None

Query Parameters

None

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Definition
sortOrder	The order in which coins are listed by default.
symbol	The abbreviation that serves as the coin's symbol. Example: Bitcoin's symbol is BTC.
coinName	The name of the coin.
imageUrl	The URL slug where this coin's logo file resides. The API provides only the slug, not the root URL, which is: https://min-api.cryptocompare.com/data/all/coinlist

","urlObject":{"path":["coin-index"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7baf0dd-20bf-7d80-3b1a-b08ec5ae8451"},{"name":"/coins/","id":"16eb025b-63ee-a6e0-a850-84233c64b25b","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/coins/?fsyms=ETH,DOGE&tsyms=BTC,USD","description":"

Coins Info

This endpoint delivers current listing data for the requested coins

Path Parameters

None

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Definition
fsyms	\"from symbols\" - a comma-separated list of coin symbols for which you want data
tsyms	\"to symbols\" - a comma-separated list of coin or currency symbols in which you want to see pricing data.
Example: for the query string `?fsyms=ETH,DOGE&tsyms=BTC,USD` you'll see data on ETH and DOGE, expressed as prices in BTC and USD.

Response Fields

each fsym will have these entries for each tsym

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Definition	CC API Endpoint	CC API Variable
marketCap	The order in which coins are listed by default.	/pricemultifull	MKTCAP
supply	Total coins in circulation.	/pricemultifull	SUPPLY
24HrVolume	Total 24-hour volume, expressed in the current `tsym`.	/pricemultifull	TOTALVOLUME24HTO
24HrPctPrice	24-hour % price change against the current `tsym`.	/pricemultifull	CHANGEPCT24HOUR
price	The CCCAGG (CryptoCompare Combined Aggregate) price expressed in the current `tsym`.	/pricemultifull	PRICE

","urlObject":{"path":["coins",""],"query":[{"key":"fsyms","value":"ETH,DOGE"},{"key":"tsyms","value":"BTC,USD"}],"variable":[]}},"response":[],"_postman_id":"16eb025b-63ee-a6e0-a850-84233c64b25b"},{"name":"/coin-pair-detail/","id":"4d08357c-9b1f-bdc2-b1ab-a0fd89b175ff","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/coin-pair-detail//?fsym=ETH&tsym=USD","description":"

Coin Pair Detail

Provides current and historical data

for a specified coin-pair
on a specified exchange
across a specified date range.

The endpoint retrieves and parses its data from the CryptoCompare histoday API.

Example

A call to this URI //coin-pair-detail/?fsym=ETH&tsym=BTC&exchange=LocalBitcoins would parse and format the response from https://min-api.cryptocompare.com/data/histoday?fsym=ETH&tsym=BTC&e=LocalBitcoins\nwhich is a request for a daily data history for trading from Bitcoin to Ethereum on the LocalBitcoins exchange.

Path Parameters

None

Query Parameters

Note: Coin-pairs have two halves, and an implied direction: the coin \"from\" which trades are made, \"to\" another coin that is the result of the trade.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Definition
fsym	\"from symbol\" - the coin symbol \"from\" which trades are made. This is the starting point of the coin-pair.
tsym	\"to symbol\" - the coin symbol \"to\" which trades are made. This is the ending point of the coin-pair.
fdate	\"from date\" - the date you want historical data to start (`fdate` must be before `tdate`)
tdate	\"to date\" - the date you want data to stop
exchange	\"to date\" - the date you want data to stop

Example: for the query string ?fsym=ETH&tsym=BTC&fdate=2018-01-01&tdate=2018-02-01&exchange=LocalBitcoins \nyou'll see data on ETH, expressed as prices in BTC, from Jan 1 - Feb 2, 2018, on the LocalBitcoins exchange.

Response Fields

The response object will be structured as follows:

responseObject = {\n    [exchange]: ... ,\n    [tsym]: {\n        [time]: {\n            time: ... ,\n            close: ... ,\n            high: ... ,\n            low: ... ,\n            open: ... ,\n            volumefrom: ... ,\n            volumeto: ... ,\n        }, \n        //more daily data objects\n   }    \n}\n

[tsym] is the to-symbol from the initial request\n[time] is the Unix timestamp for that day

The values of each daily data object are defined as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
time	Unix timestamp
close	closing price
high	highest price
low	lowest price
open	opening price
volumeto	volume for the day

Each of these values is taken from CryptoCompare's 24-hour data values, not their daily values.

\n","urlObject":{"path":["coin-pair-detail","",""],"query":[{"key":"fsym","value":"ETH"},{"key":"tsym","value":"USD"}],"variable":[]}},"response":[],"_postman_id":"4d08357c-9b1f-bdc2-b1ab-a0fd89b175ff"},{"name":"/exchanges","id":"18ae34a1-fcf7-d778-b975-3e0d5d7d5a78","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/exchanges/?fsym=ETH&tsym=USD","description":"

Exchanges Data

Provides today's average trading data on a specific coin-pair:

aggregated across all exchanges trading that coin-pair
for each of the top 10 exchanges trading that coin-pair

The endpoint retrieves and parses its data from the CryptoCompare top/exchanges/full API.

Example

A call to this URI /exchanges/?fsym=ETH&tsym=BTC would parse and format the response from https://min-api.cryptocompare.com/data/top/exchanges/full?fsym=BTC&tsym=ETH&limit=10\nwhich is a request for aggregated and per-exchange data for the top 10 exchanges trading the Bitcoin to Ethereum coin-pair.

Path Parameters

None

Query Parameters

Note: Coin-pairs have two halves, and an implied direction: the coin \"from\" which trades are made, \"to\" another coin that is the result of the trade.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Definition
fsym	\"from symbol\" - the coin symbol \"from\" which trades are made. This is the starting point of the coin-pair.
tsym	\"to symbol\" - the coin symbol \"to\" which trades are made. This is the ending point of the coin-pair.

Response Fields

The response object will be structured as follows:

responseObject = {\n    fsym: [fsym],\n    tsym: [tsym],\n    aggregated: {\n        exchange: \"aggregated\",\n        lastUpdated: [last updated],\n        closing: ... ,\n        high: ... ,\n        low: ... ,\n        open: ... ,\n        volumefrom: ... ,\n    },\n    exchanges: {\n        [exchange]: {\n            exchange: [exchange], //exchange name is a string\n            lastUpdated: [last updated],\n            closing: ... ,\n            high: ... ,\n            low: ... ,\n            open: ... ,\n            volumefrom: ... ,\n        }, \n        //more data objects for each exchange\n   }    \n}\n

[tsym] is the to-symbol from the initial request
[time] is the Unix timestamp for that day

The values of each daily data object are defined as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
exchange	name of the exchange
lastUpdated	Unix timestamp for when this data object was last updated
closing	closing price
high	highest price
low	lowest price
open	opening price
volumeto	volume for the day

Where there's a choice, each of these values is taken from CryptoCompare's 24-hour data values, not their daily values.

\n","urlObject":{"path":["exchanges",""],"query":[{"key":"fsym","value":"ETH"},{"key":"tsym","value":"USD"}],"variable":[]}},"response":[],"_postman_id":"18ae34a1-fcf7-d778-b975-3e0d5d7d5a78"},{"name":"/user/:userId","id":"94d5ae46-3d59-4e69-ced7-5adde09dd273","request":{"method":"GET","header":[],"url":"/user/:userId","description":"

Retrieves basic user info for a user ID

\n","urlObject":{"path":["user",":userId"],"query":[],"variable":[{"type":"any","key":"userId"}]}},"response":[],"_postman_id":"94d5ae46-3d59-4e69-ced7-5adde09dd273"},{"name":"/user/","id":"cf9fd5f7-43e7-936a-f9f4-a2764e710093","request":{"method":"POST","header":[],"url":"/user/","description":"

Creates a new user with basic information

Work in Progress, subject to change

Receives POST requests to create new users with basic information and responds with the newly-saved user data object, or with a failure code.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Definition
email	email address
passwordHash	hashed password

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Definition
email	email address

","urlObject":{"path":["user",""],"query":[],"variable":[]}},"response":[],"_postman_id":"cf9fd5f7-43e7-936a-f9f4-a2764e710093"},{"name":"/user/","id":"a7207975-f6a6-beb5-2666-2b80b23e852e","request":{"method":"PUT","header":[],"url":"/user/","description":"

Updates a user's basic information

\n","urlObject":{"path":["user",""],"query":[],"variable":[]}},"response":[],"_postman_id":"a7207975-f6a6-beb5-2666-2b80b23e852e"},{"name":"/portfolio/:userId","id":"ff3123c6-0413-4dca-9916-6b6e5b355926","request":{"method":"GET","header":[],"url":"/portfolio/:userId","description":"

Portfolio Data

Provides the complete portfolio of coins that a user currenctly owns.

Path Parameters

userId - the ID for the user of interest.

Query Parameters

None

Response Fields

The response object will be structured as follows:

responseObject = {\n    userId: [userId],\n    cash: [cash on hand],\n    invested: [amount of cash invested],\n    portfolio:  {\n        coin: [coin symbol],\n        quantity: [quantity of coin owned],\n        },  \n        //more data objects for each coin type the user owns\n   }    \n}\n

","urlObject":{"path":["portfolio",":userId"],"query":[],"variable":[{"type":"any","key":"userId"}]}},"response":[],"_postman_id":"ff3123c6-0413-4dca-9916-6b6e5b355926"},{"name":"/history/:userId","id":"228420a4-9288-93f7-3106-65cf2e5a59b7","request":{"method":"GET","header":[],"url":"/history/:userId","description":"

Trade History Data

Provides the complete history of trades that a user has executed.

Path Parameters

userId - the ID for the user of interest.

Query Parameters

None

Response Fields

The response object will be structured as follows:

responseObject = {\n    userId: [userId],\n    trades: {\n        [time]: {\n           time: [time],\n            fsym:'ETH',\n            fquantity: 1,\n            tsym: 'USD',\n            tquantity: 1000`,\n        },  \n        //more data objects for each trade the user has executed. \n   }    \n}\n

[time] is the Unix timestamp for when the trade was saved.

\n","urlObject":{"path":["history",":userId"],"query":[],"variable":[{"type":"any","key":"userId"}]}},"response":[],"_postman_id":"228420a4-9288-93f7-3106-65cf2e5a59b7"},{"name":"/trade","id":"9ec4c3fa-fd56-128a-1203-806881691338","request":{"method":"POST","header":[],"url":"/trade","description":"

Make a Trade

This endpoint receives POST requests containing a trade to be executed, stores the information, and responds with the newly-saved transaction data object, or with a failure code.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Definition
fsym	\"from symbol\" - the coin symbol or currency to be given/sold in the exchange
fquantity	\"from quantity\" - the quantity of the coin or currency being given/sold
tsym	\"to symbol\" - the coin symbol or currency to be received/bought in the exchange
tquantity	\"to quantity\" - the quantity of the coin or currency being received/bought

Example

A POST to this URI /trade/ with the body:

trade: {\n    fsym:'ETH',\n    fquantity: 1,\n    tsym: 'USD',\n    tquantity: 1000,\n}\n

would represent a trade where 1 ETH was sold in exchange for USD$1000.

Response Fields

The response object will be structured as follows:

[time]: {\n    time: [time],\n    fsym:'ETH',\n    fquantity: 1,\n    tsym: 'USD',\n    tquantity: 1000,\n}\n

[time] is the Unix timestamp for when the trade was saved.

\n","urlObject":{"path":["trade"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ec4c3fa-fd56-128a-1203-806881691338"},{"name":"/invest/","id":"12c82b0d-a3be-bd4e-fe0b-540de171ac8e","request":{"method":"POST","header":[],"url":"/invest/","description":"

Invest More Money

Allows a user to deposit more cash into their account.

Work In Progress - Subject to Change

\n","urlObject":{"path":["invest",""],"query":[],"variable":[]}},"response":[],"_postman_id":"12c82b0d-a3be-bd4e-fe0b-540de171ac8e"},{"name":"/leaderboard","id":"5c518ac2-d03a-331e-b2a3-47054cf8603a","request":{"method":"GET","header":[],"url":"/leaderboard","description":"

Leaderboard

View the standings of all players, and your own against those players close to you, based on profits generated in the last week.

Work in Progress - Subject to Change

\n","urlObject":{"path":["leaderboard"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c518ac2-d03a-331e-b2a3-47054cf8603a"}]}