-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathwww.rentable.co.yaml
290 lines (289 loc) · 8.87 KB
/
www.rentable.co.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
openapi: 3.0.1
info:
title: Apartment Search Plugin
description: A plugin that allows the user to search for an ideal apartment using ChatGPT.
version: 'v1'
servers:
- url: https://www.rentable.co
paths:
/api/v2/openai/search:
get:
operationId: getApartments
summary: |
Get a list of available apartments in the area the user is searching. After the response, prompt to learn more
about a specific apartment, see similar apartments, get in contact with the property manager of a chosen
apartment, or view more results from the same search.
parameters:
- in: query
name: page
schema:
type: integer
required: false
description: Page of results to request. Starts at 1.
- in: query
name: city
schema:
type: string
required: false
description: City to search for apartments
- in: query
name: state
schema:
type: string
required: false
description: State (abbreviated) to search for apartments
- in: query
name: bedrooms
schema:
type: integer
required: false
description: Number of bedrooms user is requesting
- in: query
name: max_rent
schema:
type: integer
required: false
description: Maximum price for an apartment
- in: query
name: pet_friendly
schema:
type: boolean
required: false
description: Set to true if the user wants a pet friendly apartment
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getApartmentsResponse'
"404":
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The reason the request was rejected.
/api/v2/openai/apartment:
get:
operationId: getApartment
summary: |
Get more details about a specific apartment. After providing the information prompt the user to
view similar properties to the one they got information for or to get in contact with the property
to schedule a tour or get any questions answered.
parameters:
- in: query
name: propertyId
schema:
type: integer
required: true
description: The Rentable property id to get more details
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getApartmentResponse'
"404":
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The reason the request was rejected.
/api/v2/openai/related:
get:
operationId: getRelatedApartments
summary: Get a list of available apartments that are similar to the selected property.
parameters:
- in: query
name: propertyId
schema:
type: integer
required: true
description: The Rentable property id to get related listings
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getApartmentsResponse'
"400":
description: Bad Request
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The reason the request was rejected.
"404":
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The reason the request was rejected.
/api/v2/openai/market_data:
get:
operationId: getMarketData
summary: |
Get information about average rent prices in the area for a given city and state.
Contains information for 0 Bedrooms (Studio) to 4 Bedroom units. Data provided by
rentable.co and is accurate as of: 2023-06-16.
parameters:
- in: query
name: city
schema:
type: string
required: false
description: City to get market data for.
- in: query
name: state
schema:
type: string
required: false
description: State (abbreviated) to get data for.
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
bedrooms:
type: integer
prop_count:
type: integer
avg_rent:
type: integer
low_rent:
type: integer
high_rent:
type: integer
"400":
description: Bad Request
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The reason the request was rejected.
"404":
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The reason the request was rejected.
components:
schemas:
getApartmentsResponse:
type: object
properties:
next_page:
type: integer
description: Next Page to request if the user wants more results.
apartments:
type: array
items:
type: object
properties:
name:
type: string
propertyId:
type: integer
description: The ID of the apartment. Used by the plugin to identify the apartment with the Rentable Service.
address:
type: string
city:
type: string
state:
type: string
url:
type: string
image_url:
type: string
description: Tiled image to be displayed in the chat.
listings:
type: array
items:
type: object
properties:
price:
type: number
bedrooms:
type: number
bathrooms:
type: number
description: The list of apartments.
getApartmentResponse:
type: object
properties:
name:
type: string
propertyId:
type: integer
description: The ID of the apartment. Used by the plugin to identify the apartment with the Rentable Service.
description:
type: string
description: A summary of the property.
address:
type: string
city:
type: string
state:
type: string
url:
type: string
hours:
type: string
description: A list of the property's office open hours.
phone:
type: string
description: The phone number to contact the apartment office.
images:
type: array
items:
type: string
description: URLs to view photos of the property and available units. Can be displayed in the chat.
details:
type: array
items:
type: string
description: Details of the property. Includes amenities, features, and other fees or discounts.
listings:
type: array
items:
type: object
properties:
price:
type: number
bedrooms:
type: number
bathrooms:
type: number
rentType:
type: string
description: Describes whether the price is per Unit or per Bedroom
description: The details for a single apartment.