Default

Add a new listing

post

Adds a new rental listing to the database and blockchain.

Authorizations
Body
idstringOptional

Optional listing ID

userIdstringRequired

User identifier associated with the listing

addressStreetstringRequired

Street address of the rental listing

addressCitystringRequired

City where the rental is located

addressStatestringRequired

State where the rental is located

addressPostalstringRequired

Postal code for the rental listing

monthlyPaymentnumberOptional

Monthly rental payment

minCreditnumberOptional

Minimum credit score requirement

prefCreditnumberOptional

Preferred credit score

minIncomenumberOptional

Minimum income requirement

prefIncomenumberOptional

Preferred income

propertyValuenumberOptional

Property value

latitudenumberOptional

Latitude coordinate (optional)

longitudenumberOptional

Longitude coordinate (optional)

walkthroughLinkstringOptional

URL for video walkthrough (optional)

Responses
201

Listing created successfully

application/json
post
POST /stage/listings HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "id": "text",
  "userId": "text",
  "addressStreet": "text",
  "addressCity": "text",
  "addressState": "text",
  "addressPostal": "text",
  "monthlyPayment": 1,
  "minCredit": 1,
  "prefCredit": 1,
  "minIncome": 1,
  "prefIncome": 1,
  "propertyValue": 1,
  "latitude": 1,
  "longitude": 1,
  "walkthroughLink": "text"
}
{
  "message": "text",
  "listingId": "text",
  "transactionHash": "text"
}

Get a specific listing

get

Retrieves a specific rental listing by its ID.

Authorizations
Path parameters
ListingKeystringRequired

The unique identifier of the listing

Responses
200

Listing retrieved successfully

application/json
get
GET /stage/listing/{ListingKey} HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "ListingId": {
    "S": "text"
  },
  "UserId": {
    "S": "text"
  },
  "StreetAddress": {
    "S": "text"
  },
  "City": {
    "S": "text"
  },
  "State": {
    "S": "text"
  },
  "PostalCode": {
    "S": "text"
  },
  "Country": {
    "S": "text"
  },
  "MonthlyRent": {
    "N": "text"
  },
  "PropertyValue": {
    "N": "text"
  },
  "Latitude": {
    "N": "text",
    "NULL": true
  },
  "Longitude": {
    "N": "text",
    "NULL": true
  },
  "walkthroughLink": {
    "S": "text"
  }
}

Get listings by user

get

Retrieves all listings for a specific user.

Authorizations
Path parameters
UserIdstringRequired

The user ID to get listings for

Responses
200

Listings retrieved successfully

application/json
get
GET /stage/listings/user/{UserId} HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "ListingId": {
      "S": "text"
    },
    "UserId": {
      "S": "text"
    },
    "StreetAddress": {
      "S": "text"
    },
    "City": {
      "S": "text"
    },
    "State": {
      "S": "text"
    },
    "PostalCode": {
      "S": "text"
    },
    "Country": {
      "S": "text"
    },
    "MonthlyRent": {
      "N": "text"
    },
    "PropertyValue": {
      "N": "text"
    },
    "Latitude": {
      "N": "text",
      "NULL": true
    },
    "Longitude": {
      "N": "text",
      "NULL": true
    },
    "walkthroughLink": {
      "S": "text"
    }
  }
]

Delete a listing

delete

Deletes a specific listing from the database.

Authorizations
Path parameters
ListingIdstringRequired

The unique identifier of the listing to delete

Responses
200

Listing deleted successfully

application/json
delete
DELETE /stage/listing/{ListingId} HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "message": "text"
}

Search listings by postal code

get

Retrieves listings filtered by postal code.

Authorizations
Path parameters
postalCodestringRequired

The postal code to search for

Responses
200

Listings retrieved successfully

application/json
get
GET /stage/listings/postal/{postalCode} HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "ListingId": {
      "S": "text"
    },
    "UserId": {
      "S": "text"
    },
    "StreetAddress": {
      "S": "text"
    },
    "City": {
      "S": "text"
    },
    "State": {
      "S": "text"
    },
    "PostalCode": {
      "S": "text"
    },
    "Country": {
      "S": "text"
    },
    "MonthlyRent": {
      "N": "text"
    },
    "PropertyValue": {
      "N": "text"
    },
    "Latitude": {
      "N": "text",
      "NULL": true
    },
    "Longitude": {
      "N": "text",
      "NULL": true
    },
    "walkthroughLink": {
      "S": "text"
    }
  }
]

Search listings by city

get

Retrieves listings filtered by city.

Authorizations
Path parameters
citystringRequired

The city to search for

Responses
200

Listings retrieved successfully

application/json
get
GET /stage/listings/city/{city} HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "ListingId": {
      "S": "text"
    },
    "UserId": {
      "S": "text"
    },
    "StreetAddress": {
      "S": "text"
    },
    "City": {
      "S": "text"
    },
    "State": {
      "S": "text"
    },
    "PostalCode": {
      "S": "text"
    },
    "Country": {
      "S": "text"
    },
    "MonthlyRent": {
      "N": "text"
    },
    "PropertyValue": {
      "N": "text"
    },
    "Latitude": {
      "N": "text",
      "NULL": true
    },
    "Longitude": {
      "N": "text",
      "NULL": true
    },
    "walkthroughLink": {
      "S": "text"
    }
  }
]

Generic search for listings

get

Performs a case-insensitive search on listings based on field and value.

Authorizations
Query parameters
fieldstringRequired

The field to search in

valuestringRequired

The value to search for

Responses
200

Listings retrieved successfully

application/json
get
GET /stage/listings/search HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "ListingId": {
      "S": "text"
    },
    "UserId": {
      "S": "text"
    },
    "StreetAddress": {
      "S": "text"
    },
    "City": {
      "S": "text"
    },
    "State": {
      "S": "text"
    },
    "PostalCode": {
      "S": "text"
    },
    "Country": {
      "S": "text"
    },
    "MonthlyRent": {
      "N": "text"
    },
    "PropertyValue": {
      "N": "text"
    },
    "Latitude": {
      "N": "text",
      "NULL": true
    },
    "Longitude": {
      "N": "text",
      "NULL": true
    },
    "walkthroughLink": {
      "S": "text"
    }
  }
]

Get listing requirements

get

Retrieves requirements for a listing from blockchain contract.

Authorizations
Path parameters
ListingKeystringRequired

The listing ID to query requirements for

Responses
200

Requirements retrieved successfully

application/json
get
GET /stage/listing/requirements/{ListingKey} HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "listingId": "text",
  "minCreditScore": 1,
  "prefCreditScore": 1,
  "minIncome": 1,
  "prefIncome": 1
}

Get saved listings for user

get

Retrieves saved listings for a specific user.

Authorizations
Path parameters
userIdstringRequired

The user ID to get saved listings for

Responses
200

Saved listings retrieved successfully

application/json
get
GET /stage/savedListings/{userId} HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "savedListings": {
    "UserKey": "text",
    "ListingIds": {
      "SS": [
        "text"
      ]
    }
  },
  "listingDetails": [
    {
      "ListingId": {
        "S": "text"
      },
      "UserId": {
        "S": "text"
      },
      "StreetAddress": {
        "S": "text"
      },
      "City": {
        "S": "text"
      },
      "State": {
        "S": "text"
      },
      "PostalCode": {
        "S": "text"
      },
      "Country": {
        "S": "text"
      },
      "MonthlyRent": {
        "N": "text"
      },
      "PropertyValue": {
        "N": "text"
      },
      "Latitude": {
        "N": "text",
        "NULL": true
      },
      "Longitude": {
        "N": "text",
        "NULL": true
      },
      "walkthroughLink": {
        "S": "text"
      }
    }
  ]
}

Save a listing for user

post

Adds a listing to a user's saved listings.

Authorizations
Body
userIdstringRequired

The user ID

listingIdstringRequired

The listing ID to save

Responses
200

Listing saved successfully

application/json
post
POST /stage/savedListings HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "userId": "text",
  "listingId": "text"
}
{
  "message": "text"
}

Remove saved listing

delete

Removes a listing from a user's saved listings.

Authorizations
Path parameters
userIdstringRequired

The user ID

listingIdstringRequired

The listing ID to remove

Responses
200

Listing removed successfully

application/json
delete
DELETE /stage/savedListings/{userId}/{listingId} HTTP/1.1
Host: 2glwwoadjj.execute-api.us-east-1.amazonaws.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "message": "text"
}
PreviousListingNextModels