-
Notifications
You must be signed in to change notification settings - Fork 0
/
eBird_openapi.yml
559 lines (553 loc) · 14.9 KB
/
eBird_openapi.yml
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
openapi: 3.0.0
info:
title: eBird API Integration
version: 1.0.0
servers:
- url: 'https://api.ebird.org/v2'
paths:
/data/obs/{regionCode}/historic/{y}/{m}/{d}:
get:
summary: Historic Observations on a Date
operationId: getHistoricObservations
parameters:
- name: regionCode
in: path
required: true
schema:
type: string
- name: y
in: path
required: true
schema:
type: string
- name: m
in: path
required: true
schema:
type: string
- name: d
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/HistoricObservationResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'429':
$ref: '#/components/responses/ErrorResponse'
/product/top100/{regionCode}/{y}/{m}/{d}:
get:
summary: Top 100 Contributors on a Given Date
operationId: getTopContributors
parameters:
- name: regionCode
in: path
required: true
schema:
type: string
- name: y
in: path
required: true
schema:
type: string
- name: m
in: path
required: true
schema:
type: string
- name: d
in: path
required: true
schema:
type: string
responses:
'200':
description: List of top contributors
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Contributor'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'429':
$ref: '#/components/responses/ErrorResponse'
/data/obs/geo/recent/{speciesCode}:
get:
summary: Recent Nearby Observations of a Species
operationId: getRecentNearbyObservations
parameters:
- name: speciesCode
in: path
required: true
schema:
type: string
- name: lat
in: query
required: true
schema:
type: number
- name: lng
in: query
required: true
schema:
type: number
responses:
'200':
description: List of recent nearby observations
content:
application/json:
schema:
$ref: '#/components/schemas/ObservationArray'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'429':
$ref: '#/components/responses/ErrorResponse'
/data/nearest/geo/recent/{speciesCode}:
get:
summary: Nearest Observations of a Species
operationId: getNearestObservations
parameters:
- name: speciesCode
in: path
required: true
schema:
type: string
- name: lat
in: query
required: true
schema:
type: number
- name: lng
in: query
required: true
schema:
type: number
responses:
'200':
description: List of nearest observations
content:
application/json:
schema:
$ref: '#/components/schemas/ObservationArray'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'429':
$ref: '#/components/responses/ErrorResponse'
/data/obs/{regionCode}/recent:
get:
summary: Recent Observations in a Region
operationId: getRecentObservations
parameters:
- name: regionCode
in: path
required: true
schema:
type: string
- name: back
in: query
required: false
schema:
type: integer
- name: cat
in: query
required: false
schema:
type: string
- name: hotspot
in: query
required: false
schema:
type: boolean
- name: includeProvisional
in: query
required: false
schema:
type: boolean
- name: maxResults
in: query
required: false
schema:
type: integer
- name: sppLocale
in: query
required: false
schema:
type: string
responses:
'200':
description: List of recent observations
content:
application/json:
schema:
$ref: '#/components/schemas/ObservationArray'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'429':
$ref: '#/components/responses/ErrorResponse'
/data/obs/{regionCode}/recent/notable:
get:
summary: Recent Notable Observations in a Region
operationId: getRecentNotableObservations
parameters:
- name: regionCode
in: path
required: true
schema:
type: string
- name: back
in: query
required: false
schema:
type: integer
- name: detail
in: query
required: false
schema:
type: string
responses:
'200':
description: List of recent notable observations
content:
application/json:
schema:
$ref: '#/components/schemas/ObservationArray'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'429':
$ref: '#/components/responses/ErrorResponse'
/data/obs/geo/recent:
get:
summary: Recent Nearby Observations
operationId: getRecentNearbyObservationsGeneral
parameters:
- name: lat
in: query
required: true
schema:
type: number
- name: lng
in: query
required: true
schema:
type: number
responses:
'200':
description: List of recent nearby observations
content:
application/json:
schema:
$ref: '#/components/schemas/ObservationArray'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'429':
$ref: '#/components/responses/ErrorResponse'
components:
parameters:
regionCode:
name: regionCode
in: path
required: true
schema:
type: string
year:
name: y
in: path
description: Year of the observation.
required: true
schema:
type: string
pattern: '^\d{4}$'
month:
name: m
in: path
description: Month of the observation.
required: true
schema:
type: string
pattern: '^\d{1,2}$'
minLength: 1
maxLength: 2
day:
name: d
in: path
description: Day of the observation.
required: true
schema:
type: string
pattern: '^\d{1,2}$'
minLength: 1
maxLength: 2
speciesCode:
name: speciesCode
in: path
description: The unique code for the species observed.
required: true
schema:
type: string
lat:
name: lat
in: query
description: Latitude for nearby observations.
required: true
schema:
type: number
format: double
lng:
name: lng
in: query
description: Longitude for nearby observations.
required: true
schema:
type: number
format: double
back:
name: back
in: query
required: false
schema:
type: integer
default: 14
minimum: 1
maximum: 30
maxResults:
name: maxResults
in: query
required: false
schema:
type: integer
default: 200
minimum: 1
maximum: 10000
hotspot:
name: hotspot
in: query
required: false
schema:
type: boolean
default: false
includeProvisional:
name: includeProvisional
in: query
required: false
schema:
type: boolean
default: false
sppLocale:
name: sppLocale
in: query
required: false
schema:
type: string
default: 'en'
cat:
name: cat
in: query
description: Category of the species (e.g., 'domestic', 'form', 'hybrid', 'intergrade', 'issf', 'slash', 'species', 'spuh').
required: false
schema:
type: string
default: 'species'
detail:
name: detail
in: query
description: Level of detail for the observation records, can be 'simple' or 'full'.
required: false
schema:
type: string
enum:
- simple
- full
default: 'full'
schemas:
HistoricObservationResponse:
type: object
properties:
speciesCode:
type: string
description: A unique code assigned to the species observed.
comName:
type: string
description: Common name of the species observed.
sciName:
type: string
description: Scientific name of the species observed.
locId:
type: string
description: Unique identifier for the location of the observation.
locName:
type: string
description: Name of the location where the observation was made.
obsDt:
type: string
description: Date and time of the observation.
howMany:
type: integer
description: The number of individuals observed.
lat:
type: number
format: double
description: Latitude of the observation location.
lng:
type: number
format: double
description: Longitude of the observation location.
obsValid:
type: boolean
description: Whether the observation has been validated.
obsReviewed:
type: boolean
description: Whether the observation has been reviewed.
locationPrivate:
type: boolean
description: Whether the location of the observation is private.
Observation:
type: object
properties:
speciesCode:
type: string
description: A unique code assigned to the species observed.
comName:
type: string
description: Common name of the species observed.
sciName:
type: string
description: Scientific name of the species observed.
locId:
type: string
description: Unique identifier for the location of the observation.
locName:
type: string
description: Name of the location where the observation was made.
obsDt:
type: string
description: Date and time of the observation.
howMany:
type: integer
description: The number of individuals observed.
lat:
type: number
format: double
description: Latitude of the observation location.
lng:
type: number
format: double
description: Longitude of the observation location.
obsValid:
type: boolean
description: Whether the observation has been validated.
obsReviewed:
type: boolean
description: Whether the observation has been reviewed.
locationPrivate:
type: boolean
description: Whether the location of the observation is private.
Contributor:
type: object
properties:
userId:
type: string
description: Unique identifier for the contributor.
userName:
type: string
description: Name of the contributor.
userDisplayName:
type: string
description: Display name of the contributor.
observationCount:
type: integer
description: Number of observations contributed by the user on the specified date.
ObservationArray:
type: array
items:
$ref: '#/components/schemas/Observation'
ErrorResponse:
type: object
properties:
code:
type: integer
description: HTTP status code of the error.
message:
type: string
description: A descriptive message about the error.
responses:
ErrorResponse:
description: Error response indicating what went wrong during the API call.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
HistoricObservationResponse:
description: Detailed response for historic observations.
content:
application/json:
schema:
$ref: '#/components/schemas/HistoricObservationResponse'
ObservationResponse:
description: Response for general observations data.
content:
application/json:
schema:
$ref: '#/components/schemas/ObservationArray'
ContributorResponse:
description: Response containing data about contributors.
content:
application/json:
schema:
$ref: '#/components/schemas/Contributor'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-eBirdApiToken
security:
- ApiKeyAuth: []