Our REST API

Overview

Costs to Expect is a service focused on tracking and forecasting expenses. We are trying to simplify your budgets. There are three core products in the service; the Open Source REST API, our App and an Open Source website showing the costs to raise our children to adulthood.

Our API is the backbone of the service, everything depends on it. Our API is available to anyone who wants to use it. Our focus is expenses, however, that will change as the product matures.

Access API View our API on Github

The documentation for the API is available as a Postman collection.

Examples Postman

---

Our Products

There are multiple products within the Costs to Expect service, the major products being our API and App, below is a quick overview of each product.

Our API

Our Open Source REST API, available under the MIT license, the API drives the entire service.

Our App

Our App is the commercial offering for Costs to Expect, we are working towards the public alpha, our aim is to make tracking and forecasting expenses as simple as possible.

Our Website

Our website is a long-term social project. My wife and I are tracking all the expenses to raise our child to adulthood.

Our Blog

Our blog acts as a central repository to list all updates, explains why we are doing what we are and acts as a place for us to talk about our products and the service.

---

Latest release v2.20.0

The latest release of the Costs to Expect API is v2.20.0; we released it on the 15th Feb 2021.

The changelog below shows all the fixes and improvements we have made, to view the entire changelog please check here.

Added

• We have added a JSON `data` field to resource types. The `data` field can be used to store any optional data specific to your resource type.
• We have added a JSON `data` field to resources. The `data` field can be used to store any optional data specific to your resource.
• We have added additional tests.

Changed

• We have updated our dev dependencies and switched to a new faker library.
• We have moved the `Header` class to the `App\Response` namespace.
• We have tweaked our `Option` classes; we no longer use the same data array to generate Post and Get responses.

Fixed

• We have corrected our resource-type and resources schemas; the required properties nesting is correct.

Removed

• We have removed the `effective_date` field from resources; the new `data` field will take over responsibility for storing this data as necessary.
• We have removed the `Response\Header\Headers` class; the class is mostly duplicated code and serves no purpose.