Coinscale API

This RESTful API backend serves Coinscale, a cryptocurrency trading simulator. For a general description of the application and documentation of the client-side code, please see this repository. A deployed version of the app can be found at https://coinscale.netlify.com/.

Endpoints

Create user

Creates new user and sends username in response.

• URL: /api/users
• Method: POST
• URL params: None
• Data params:

{
    username: [string],
    password: [string]
}

• Success response example: { username: "Satoshi Nakamoto" }

---

Log in

Authenticates existing user and returns JWT token.

• URL: /api/auth/login
• Method: POST
• URL params: None
• Data params:

{
    username: [string],
    password: [string]
}

• Success response example: { authToken: [string] }

Refresh auth token

Returns fresh JWT token.

• URL: /api/auth/refresh
• Method: POST
• URL params: None
• Data params: None
• Success response example: { authToken: [string] }

---

Show price data

Returns array of price data for a basket of cryptocurrencies in the 7-day interval leading up to query parameter {date}.

• URL: /api/prices?date={date}
• Method: GET
• Query params: date=[string]
• Data params: None
• Success response example:

{ priceData:
    [
        {
            currency: "BTC",
            name: "Bitcoin",
            current: "1017.20",
            sevenDaysAgo: "914.20"
        },
        ...
    ]
}

---

Show portfolio

Returns user's portfolio, or creates and returns new portfolio if one does not exist.

• URL: /api/portfolio
• Method: GET
• URL params: None
• Data params: None
• Success response example:

{ portfolio:
    {
        id: "5b51ee16a0e0b72574d2c21d",
        balance: 18500,
        holdings: {
            BTC: 1,
            ETH: 20
        }
    }
}

Update portfolio

Updates user's portfolio.

• URL: /api/portfolio/:id
• Method: PUT
• URL params: id=[string]
• Data params:

{ portfolio:
    {
        id: [string],
        balance: [number],
        holdings: {
            [string]: [number],
            ...
        }
    }
}

• Success response example: N/A

---

Show all transactions

Returns array of transactions for user.

• URL: /api/transactions
• Method: GET
• URL params: None
• Data params: None
• Success response example:

{ transactions:
    [
        {
            id: "5b51ee16a0e0b72574d2c21d",
            date: "2017-01-01",
            type: "Buy",
            symbol: "BTC",
            price: 1017.20,
            amount: 1
        },
        ...
    ]
}

Create transaction

Creates and returns new transaction.

• URL: /api/transactions
• Method: POST
• URL params: None
• Data params:

{
    date: [string],
    type: [string],
    symbol: [string],
    price: [number],
    amount: [number]
}

• Success response example:

{
    id: "5b51ee16a0e0b72574d2c21d",
    date: "2017-01-01",
    type: "Buy",
    symbol: "BTC",
    price: 1017.20,
    amount: 1
}