-
Notifications
You must be signed in to change notification settings - Fork 8
/
openapi.yaml
179 lines (175 loc) · 5.84 KB
/
openapi.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
openapi: 3.0.0
info:
version: 2.0.0
title: Auctions API
description: GSA Auctions API is a public GET API. The Auction listings will be delivered to the user in two formats. One is JSON and the other one is XML. The auction listings delivered thru the API contains the auction listings from all the participating agencies.
paths:
'/auctions':
get:
summary: Auction listings
description: |
this endpoint returns auction listings.
responses:
'200':
description: A JSON object containing an array of auction listings
content:
application/json:
schema:
type: object
items:
$ref: '#/components/schemas/result'
servers:
- url: 'https://api.gsa.gov/assets/gsaauctions/v2/'
components:
schemas:
result:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/auction'
description: Array of auction listings.
auction:
type: object
properties:
SaleNo:
type: string
description: This field identifies a specific sale number created by the region
LotNo:
type: integer
format: int32
description: This code indicating the sequential order in which an item appears on an invitation for bid
AucStartDt:
type: string
description: Auction start date
AucEndDt:
type: string
description: Auction end date
ItemName:
type: string
description: This is the brief description of the item
PropertyAddr1:
type: string
description: Agency name where property is located
PropertyAddr2:
type: string
description: Agency 2nd line of clear text address
PropertyAddr3:
type: string
description: P.O. Box/street address name of where property is located
PropertyCity:
type: string
description: Property location city
PropertyState:
type: string
description: Property location state
PropertyZip:
type: string
description: Property location zip code
AuctionStatus:
type: string
description: Property location zip code
SaleLocation:
type: string
description: Location of sale
LocationOrg:
type: string
description: Location organizational subdivision
LocationStAddr:
type: string
description: Location P.O. Box/Street address
LocationCity:
type: string
description: City sale Location
LocationST:
type: string
description: State abbreviation location
LocationZip:
type: string
description: Sale location zip code
BiddersCount:
type: integer
format: int64
description: Number of Bidders on the sale
LotInfo:
type: array
items:
$ref: '#/components/schemas/lotinfo'
description: Array of LotInfo objects.
Instruction1:
type: string
description: Special Inspection Instructions Line 1
Instruction2:
type: string
description: Special Inspection Instructions Line 2
Instruction3:
type: string
description: Special Inspection Instructions Line 3
ContractOfficer:
type: string
description: The Sales Contracting Officer that is assigned to the sale
COEmail:
type: string
description: The Email address for the Sales Contracting Officer that is assigned to the sale
COPhone:
type: string
description: The Phone number for the Sales Contracting Officer that is assigned to the sale
Reserve:
type: number
format: float
description: The minimum dollar amount that the sale must reach before it may be awarded to a bidder
AucIncrement:
type: number
format: float
description: The bid increment that the sale use during the bidding process
HighBidAmount:
type: string
description: Highest bid amount
InactivityTime:
type: integer
format: int32
description: The period of time in minutes that there is no bidding activity on a sale
AgencyCode:
type: string
description: Agency Code
BureauCode:
type: string
description: Bureau Code
AgencyName:
type: string
description: Agency Name
BureauName:
type: string
description: Bureau Name
ItemDescURL:
type: string
description: Item description URL
ImageURL:
type: string
description: URL of an item image
lotinfo:
type: object
properties:
LotSequence:
type: integer
format: int32
description: Lot Sequence Number
LotDescript:
type: string
description: Lot Description
parameters:
format:
name: format
in: query
description: The format to return results in. Default is json.
schema:
type: integer
required: false
securitySchemes:
ApiKeyAuth: # arbitrary name for the security scheme
type: apiKey
in: header # can be "header", "query" or "cookie"
name: X-API-KEY # name of the header, query parameter or cookie
security:
- ApiKeyAuth: []