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.

Docs and Examples Postman Collection

---

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.11.6

The latest release of the Costs to Expect API is v2.11.6; we released it on the 1st Jul 2020.

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

Added

• We have added support for an `X-Skip-Cache` request header; If you include the header with your request we will skip response caching and fetch live values, please use this with care.

Changed

• We have added separate links for the documentation and example page and the postman collection.
• We have simplified our `\Model\Transformer` classes and made it possible to alter the returned data format.
• We have added `public` as a sorting option for resource types.
• We have reworked our pagination class; we have moved it to a new workspace and also improved how it works.
• We have moved our `Hash` class; the `Hash` class now lives in the `Request` namespace.
• We have moved our `ModelUtility` class: the `ModelUtility` class now lives in the `Models` namespace.
• We have updated the indexes in our `Hash` request class; the indexes are consistent with the rest of the app.

Fixed

• We have updated our pagination helper to include any defined filtering parameters.
• We have corrected pagination calls in all our controllers; we now include all possible request parameters.
• We have corrected calls to clear public caches; we were comparing different types.