> For the complete documentation index, see [llms.txt](https://loanpredictor.gitbook.io/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://loanpredictor.gitbook.io/api-docs/readme.md).

# Overview

## General Principals

### Endpoints

The API gateway   can be reached via the following root URL :

**`https://api.loanpredictor.live`**

### Available HTTP Verbs

The loanpredictor API uses the following method(s) for its' functionality:

| Method                                    | Description                                         |
| ----------------------------------------- | --------------------------------------------------- |
| <mark style="color:yellow;">`POST`</mark> | Used for querying loan features to get a prediction |

Data submitted to the API must be in **JSON** format, all responses from the API are also in **JSON** format.

### Jump right in