API Documentation

Introduction

Our API allows you to access foreclosure data efficiently.

Authentication

All API requests require an API key to be included in the headers:

curl -X GET -H "X-API-KEY: YOUR_API_KEY" https://api.tworivers.cloud/api/addresses/

Fetch the second page of foreclosure addresses:

curl -X GET -H "X-API-KEY: YOUR_API_KEY" https://api.tworivers.cloud/api/addresses/?page=2

Fetch the third page of foreclosure addresses:

curl -X GET -H "X-API-KEY: YOUR_API_KEY" https://api.tworivers.cloud/api/addresses/?page=3

Replace YOUR_API_KEY with your actual API key.

Example in Python

import requests

url = "https://api.tworivers.cloud/api/addresses/"
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, headers=headers)
print(response.json())

Example in JavaScript

import fetch from "node-fetch";

const url = "https://api.tworivers.cloud/api/addresses/";
const headers = {"X-API-KEY": "YOUR_API_KEY"};

fetch(url, { method: "GET", headers })
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));

Endpoints

GET /api/addresses

Retrieve a list of foreclosure addresses.

Response

{
  {
  "count":569,
  "next":"https://api.tworivers.cloud/api/addresses/?page=2",
  "previous":null,
  "results":
            {
              "addresses":
                          [
                          "1234 St, SAN ANTONIO, TEXAS, 78259",
                          "5678 St, SAN ANTONIO, TEXAS, 78251"
                         ]
            }
  }
}