· 6 years ago · Nov 11, 2019, 07:38 PM
1openapi: 3.0.1
2info:
3 title: Location Intelligence API
4 version: 2.0.0
5 description: Use LI API data to access RMS model insights in a flexible, scalable, and programmable way. The suite of layers includes exposure enhancement, geocoding, hazard, risk scoring, and loss costs to provide information for key decisions in the underwriting workflow, including screening, selection, and pricing.
6servers:
7 - url: https://LI_API_URL
8externalDocs:
9 description: Find out more about RMS
10 url: 'https://www.rms.com/programs/location-intelligence-api/'
11tags:
12 - name: Geocoding
13 description: Geocodes an address
14 - name: Composite
15 description: Returns multiple layers for an address, including chaining the output of one layer into the input for another
16 - name: Risk lookups
17 description: Returns one exposure, hazard, risk score, or loss cost layer for an address
18paths:
19 /geocode/latest:
20 $ref: '#/paths/~1geocode~118.0'
21 /geocode/18.1:
22 $ref: '#/paths/~1geocode~118.0'
23 /geocode/18.0:
24 post:
25 tags:
26 - Geocoding
27 summary: Geocode address
28 requestBody:
29 description: Address to geocode
30 content:
31 application/json:
32 schema:
33 $ref: '#/components/schemas/GeocodeInput'
34 example:
35 countryCode: "US"
36 countryScheme: "ISO2A"
37 countryRmsCode: "US"
38 admin1Code: "CA"
39 postalCode: "94560"
40 streetAddress: "7575 GATEWAY BLVD"
41 required: true
42 responses:
43 '200':
44 description: Everything worked as expected.
45 content:
46 application/json:
47 schema:
48 $ref: '#/components/schemas/GeocodeOutput'
49 '400':
50 $ref: '#/components/responses/400Response'
51 '401':
52 $ref: '#/components/responses/401Response'
53 '500':
54 $ref: '#/components/responses/500Response'
55 /composite:
56 post:
57 tags:
58 - Composite
59 summary: Perform Multiple Lookups for a Location. If geocoding is included, that geocoded address is used for all other lookups.
60 operationId: composite
61 requestBody:
62 description: Request
63 content:
64 application/json:
65 schema:
66 $ref: '#/components/schemas/CompositeInput'
67 example:
68 location:
69 address:
70 admin1Code: "CA"
71 cityName: "NEWARK"
72 countryCode: "US"
73 countryScheme: "ISO2A"
74 postalCode: "94560"
75 streetAddress: "7575 GATEWAY BLVD"
76 characteristics:
77 construction: ATC1
78 occupancy: ATC1
79 yearBuilt: 1973
80 numOfStories: 3
81 coverageValues:
82 buildingValue: 1000000
83 contentsValue: 100000
84 businessInterruptionValue: 50000
85 layers:
86 - name: geocode
87 version: latest
88 - name: us_eq_loss_cost
89 version: latest
90 - name: us_fema_firm
91 version: latest
92 options:
93 distanceUnit: feet
94 proximityDistance: 100
95
96 required: true
97 responses:
98 '200':
99 description: Everything worked as expected.
100 content:
101 application/json:
102 schema:
103 $ref: '#/components/schemas/CompositeOutput'
104 '400':
105 $ref: '#/components/responses/400Response'
106 '401':
107 $ref: '#/components/responses/401Response'
108 '500':
109 $ref: '#/components/responses/500Response'
110 /{layer}/{version}:
111 post:
112 tags:
113 - Risk lookups
114 summary: Generic Lookup
115 operationId: genericLookup
116 parameters:
117 - name: layer
118 in: path
119 description: Layer name
120 example: "us_fema_firm"
121 required: true
122 schema:
123 type: string
124 - name: version
125 in: path
126 description: Layer version
127 example: "latest"
128 required: true
129 schema:
130 type: string
131 requestBody:
132 description: Request
133 content:
134 application/json:
135 schema:
136 $ref: '#/components/schemas/GenericInput'
137 required: true
138 responses:
139 '200':
140 description: Everything worked as expected.
141 content:
142 application/json:
143 schema:
144 $ref: '#/components/schemas/GenericOutput'
145 '400':
146 $ref: '#/components/responses/400Response'
147 '401':
148 $ref: '#/components/responses/401Response'
149 '500':
150 $ref: '#/components/responses/500Response'
151 /eu_fl_depth/latest:
152 $ref: '#/paths/~1eu_fl_depth~11.0'
153 /eu_fl_depth/1.0:
154 post:
155 tags:
156 - Risk lookups
157 summary: Europe Flood Depth
158 requestBody:
159 description: Request
160 content:
161 application/json:
162 schema:
163 type: object
164 required:
165 - location
166 properties:
167 location:
168 type: object
169 allOf:
170 - $ref: '#/components/schemas/LocationInput'
171 - type: object
172 properties:
173 address:
174 type: object
175 required:
176 - latitude
177 - longitude
178 - countryRmsCode
179 - rmsGeoModelResolutionCode
180 example:
181 $ref: '#/components/examples/EuGbAddress/value'
182 characteristics:
183 type: object
184 example: {}
185 coverageValues:
186 type: object
187 example: {}
188 layerOptions:
189 type: object
190 properties:
191 lookup:
192 type: "string"
193 enum:
194 - floodDepth
195 - wetOrDry
196 - proximity
197 description: >
198 Type of lookup:
199 * `floodDepth` - Lookup flood depths
200 * `wetOrDry` - Lookup if the location is wet or dry
201 * `proximity` - Lookup max depth within proximity
202 default: "floodDepth"
203 example: "proximity"
204 defended:
205 type: boolean
206 description: "Max depth is defended/undefended (only applies to lookup type `proximity`)"
207 default: false
208 example: false
209 returnPeriod:
210 type: integer
211 description: "Return period for max depth calculation (only applies to lookup type `proximity`)"
212 default: 1000
213 example: 1000
214 proximityDistance:
215 type: "number"
216 format: "double"
217 description: "Return max depth found within this distance from the address (only applies to lookup type `proximity` and the maximum distance allowed is 1000 meters)"
218 example: 100
219 default: 100
220 distanceUnit:
221 type: "string"
222 enum:
223 - feet
224 - meters
225 description: "Distance unit"
226 default: "meters"
227 required: true
228 responses:
229 '200':
230 description: Everything worked as expected.
231 content:
232 application/json:
233 schema:
234 type: object
235 oneOf:
236 - $ref: '#/components/schemas/FlDepthInlandSurgeOutput'
237 - $ref: '#/components/schemas/FlDepthBaseOutput'
238 - $ref: '#/components/schemas/FlDepthInlandProximityOutput'
239 '400':
240 $ref: '#/components/responses/400Response'
241 '401':
242 $ref: '#/components/responses/401Response'
243 '500':
244 $ref: '#/components/responses/500Response'
245 /eu_ws_loss_cost/latest:
246 $ref: '#/paths/~1eu_ws_loss_cost~118.0'
247 /eu_ws_loss_cost/18.0:
248 post:
249 tags:
250 - Risk lookups
251 summary: Europe Windstorm Loss Cost
252 requestBody:
253 description: Request
254 content:
255 application/json:
256 schema:
257 type: object
258 required:
259 - location
260 properties:
261 location:
262 type: object
263 allOf:
264 - $ref: '#/components/schemas/LocationInput'
265 - type: object
266 properties:
267 address:
268 type: object
269 required:
270 - latitude
271 - longitude
272 - countryRmsCode
273 - rmsGeoModelResolutionCode
274 example:
275 $ref: '#/components/examples/EuGbAddress/value'
276 characteristics:
277 example:
278 $ref: '#/components/examples/CharacteristicsBasic/value'
279 coverageValues:
280 type: object
281 example: {}
282 layerOptions:
283 type: object
284 properties:
285 euwsFlag:
286 type: "integer"
287 description: >
288 Perspective:
289 * `0` - Reference view
290 * `1` - Climate view
291 * `2` - Reference view (low frequency only)
292 * `3` - Climate view (low frequency only)
293 minimum: 0
294 maximum: 3
295 default: 0
296 example: 0
297 required: true
298 responses:
299 '200':
300 description: Everything worked as expected.
301 content:
302 application/json:
303 schema:
304 $ref: '#/components/schemas/LossCostBaseOutput'
305 '400':
306 $ref: '#/components/responses/400Response'
307 '401':
308 $ref: '#/components/responses/401Response'
309 '500':
310 $ref: '#/components/responses/500Response'
311 /eu_ws_risk_score/latest:
312 $ref: '#/paths/~1eu_ws_risk_score~118.0'
313 /eu_ws_risk_score/18.0:
314 post:
315 tags:
316 - Risk lookups
317 summary: Europe Windstorm Risk Score
318 requestBody:
319 description: Request
320 content:
321 application/json:
322 schema:
323 type: object
324 required:
325 - location
326 properties:
327 location:
328 type: object
329 allOf:
330 - $ref: '#/components/schemas/LocationInput'
331 - type: object
332 properties:
333 address:
334 type: object
335 required:
336 - latitude
337 - longitude
338 - countryRmsCode
339 - rmsGeoModelResolutionCode
340 example:
341 $ref: '#/components/examples/EuGrAddress/value'
342 characteristics:
343 example:
344 $ref: '#/components/examples/CharacteristicsEuBasic/value'
345 coverageValues:
346 type: object
347 example: {}
348 required: true
349 responses:
350 '200':
351 description: Everything worked as expected.
352 content:
353 application/json:
354 schema:
355 $ref: '#/components/schemas/RiskScoreEuOutput'
356 '400':
357 $ref: '#/components/responses/400Response'
358 '401':
359 $ref: '#/components/responses/401Response'
360 '500':
361 $ref: '#/components/responses/500Response'
362 /eu_eq_loss_cost/latest:
363 $ref: '#/paths/~1eu_eq_loss_cost~118.0'
364 /eu_eq_loss_cost/18.0:
365 post:
366 tags:
367 - Risk lookups
368 summary: Europe Earthquake Loss Cost
369 requestBody:
370 description: Request
371 content:
372 application/json:
373 schema:
374 type: object
375 required:
376 - location
377 properties:
378 location:
379 type: object
380 allOf:
381 - $ref: '#/components/schemas/LocationInput'
382 - type: object
383 properties:
384 address:
385 type: object
386 required:
387 - latitude
388 - longitude
389 - countryRmsCode
390 - rmsGeoModelResolutionCode
391 example:
392 $ref: '#/components/examples/EuGrAddress/value'
393 characteristics:
394 example:
395 $ref: '#/components/examples/CharacteristicsEuBasic/value'
396 coverageValues:
397 type: object
398 example: {}
399 required: true
400 responses:
401 '200':
402 description: Everything worked as expected.
403 content:
404 application/json:
405 schema:
406 $ref: '#/components/schemas/LossCostBaseOutput'
407 '400':
408 $ref: '#/components/responses/400Response'
409 '401':
410 $ref: '#/components/responses/401Response'
411 '500':
412 $ref: '#/components/responses/500Response'
413 /eu_eq_risk_score/latest:
414 $ref: '#/paths/~1eu_eq_risk_score~118.0'
415 /eu_eq_risk_score/18.0:
416 post:
417 tags:
418 - Risk lookups
419 summary: Europe Earthquake Risk Score
420 requestBody:
421 description: Request
422 content:
423 application/json:
424 schema:
425 type: object
426 required:
427 - location
428 properties:
429 location:
430 type: object
431 allOf:
432 - $ref: '#/components/schemas/LocationInput'
433 - type: object
434 properties:
435 address:
436 type: object
437 required:
438 - latitude
439 - longitude
440 - countryRmsCode
441 - rmsGeoModelResolutionCode
442 example:
443 $ref: '#/components/examples/EuGbAddress/value'
444 characteristics:
445 example:
446 $ref: '#/components/examples/CharacteristicsBasic/value'
447 coverageValues:
448 type: object
449 example: {}
450 required: true
451 responses:
452 '200':
453 description: Everything worked as expected.
454 content:
455 application/json:
456 schema:
457 $ref: '#/components/schemas/RiskScoreEuOutput'
458 '400':
459 $ref: '#/components/responses/400Response'
460 '401':
461 $ref: '#/components/responses/401Response'
462 '500':
463 $ref: '#/components/responses/500Response'
464 /nz_mmi/latest:
465 $ref: '#/paths/~1nz_mmi~118.0'
466 /nz_mmi/18.0:
467 post:
468 tags:
469 - Risk lookups
470 summary: New Zealand MMI
471 requestBody:
472 description: Request
473 content:
474 application/json:
475 schema:
476 type: object
477 required:
478 - location
479 properties:
480 location:
481 type: object
482 allOf:
483 - $ref: '#/components/schemas/LocationInput'
484 - type: object
485 properties:
486 address:
487 type: object
488 required:
489 - latitude
490 - longitude
491 - countryRmsCode
492 - rmsGeoModelResolutionCode
493 example:
494 $ref: '#/components/examples/NzAddress/value'
495 characteristics:
496 type: object
497 example: {}
498 coverageValues:
499 type: object
500 example: {}
501 required: true
502 responses:
503 '200':
504 description: Everything worked as expected.
505 content:
506 application/json:
507 schema:
508 $ref: '#/components/schemas/MmiOutput'
509 '400':
510 $ref: '#/components/responses/400Response'
511 '401':
512 $ref: '#/components/responses/401Response'
513 '500':
514 $ref: '#/components/responses/500Response'
515 /us_mmi/latest:
516 $ref: '#/paths/~1us_mmi~118.0'
517 /us_mmi/18.0:
518 post:
519 tags:
520 - Risk lookups
521 summary: U.S. MMI
522 requestBody:
523 description: Request
524 content:
525 application/json:
526 schema:
527 type: object
528 required:
529 - location
530 properties:
531 location:
532 type: object
533 allOf:
534 - $ref: '#/components/schemas/LocationInput'
535 - type: object
536 properties:
537 address:
538 type: object
539 required:
540 - latitude
541 - longitude
542 - countryRmsCode
543 - rmsGeoModelResolutionCode
544 example:
545 $ref: '#/components/examples/UsCaAddress/value'
546 characteristics:
547 type: object
548 example: {}
549 coverageValues:
550 type: object
551 example: {}
552 required: true
553 responses:
554 '200':
555 description: Everything worked as expected.
556 content:
557 application/json:
558 schema:
559 $ref: '#/components/schemas/MmiOutput'
560 '400':
561 $ref: '#/components/responses/400Response'
562 '401':
563 $ref: '#/components/responses/401Response'
564 '500':
565 $ref: '#/components/responses/500Response'
566 /us_eq_loss_cost/latest:
567 $ref: '#/paths/~1us_eq_loss_cost~118.0'
568 /us_eq_loss_cost/18.0:
569 post:
570 tags:
571 - Risk lookups
572 summary: U.S. Earthquake Loss Cost
573 requestBody:
574 description: Request
575 content:
576 application/json:
577 schema:
578 type: object
579 required:
580 - location
581 properties:
582 location:
583 type: object
584 allOf:
585 - $ref: '#/components/schemas/LocationInput'
586 - type: object
587 properties:
588 address:
589 type: object
590 required:
591 - admin1Code
592 - latitude
593 - longitude
594 - countryRmsCode
595 - rmsGeoModelResolutionCode
596 example:
597 $ref: '#/components/examples/UsCaAddress/value'
598 characteristics:
599 example:
600 $ref: '#/components/examples/CharacteristicsBasic/value'
601 coverageValues:
602 type: object
603 example: {}
604 required: true
605 responses:
606 '200':
607 description: Everything worked as expected.
608 content:
609 application/json:
610 schema:
611 $ref: '#/components/schemas/LossCostBaseOutput'
612 '400':
613 $ref: '#/components/responses/400Response'
614 '401':
615 $ref: '#/components/responses/401Response'
616 '500':
617 $ref: '#/components/responses/500Response'
618 /us_eq_risk_score/latest:
619 $ref: '#/paths/~1us_eq_risk_score~118.0'
620 /us_eq_risk_score/18.0:
621 post:
622 tags:
623 - Risk lookups
624 summary: U.S. Earthquake Risk Score
625 requestBody:
626 description: Request
627 content:
628 application/json:
629 schema:
630 type: object
631 required:
632 - location
633 properties:
634 location:
635 type: object
636 allOf:
637 - $ref: '#/components/schemas/LocationInput'
638 - type: object
639 properties:
640 address:
641 type: object
642 required:
643 - admin1Code
644 - latitude
645 - longitude
646 - countryRmsCode
647 - rmsGeoModelResolutionCode
648 example:
649 $ref: '#/components/examples/UsCaAddress/value'
650 characteristics:
651 example:
652 $ref: '#/components/examples/CharacteristicsBasic/value'
653 coverageValues:
654 type: object
655 example: {}
656 required: true
657 responses:
658 '200':
659 description: Everything worked as expected.
660 content:
661 application/json:
662 schema:
663 $ref: '#/components/schemas/RiskScoreUsOutput'
664 '400':
665 $ref: '#/components/responses/400Response'
666 '401':
667 $ref: '#/components/responses/401Response'
668 '500':
669 $ref: '#/components/responses/500Response'
670 /us_esdb_building_attributes/latest:
671 $ref: '#/paths/~1us_esdb_building_attributes~17.1'
672 /us_esdb_building_attributes/7.1:
673 post:
674 tags:
675 - Risk lookups
676 summary: U.S. ExposureSource Database (ESDB) Building Attributes
677 requestBody:
678 description: Request
679 content:
680 application/json:
681 schema:
682 type: object
683 required:
684 - location
685 properties:
686 location:
687 type: object
688 allOf:
689 - $ref: '#/components/schemas/LocationInput'
690 - type: object
691 properties:
692 address:
693 type: object
694 required:
695 - geoMatchCode
696 - streetAddress
697 - cityName
698 - admin1Code
699 - latitude
700 - longitude
701 - countryRmsCode
702 - rmsGeoModelResolutionCode
703 example:
704 $ref: '#/components/examples/UsTxAddressEsdb/value'
705 characteristics:
706 type: object
707 example: {}
708 coverageValues:
709 type: object
710 example: {}
711 layerOptions:
712 type: object
713 properties:
714 useOutputForOtherLayers:
715 type: "boolean"
716 description: "In a composite call, use the ESDB attributes for other risk score and loss cost lookups"
717 default: false
718 required: true
719 responses:
720 '200':
721 description: Everything worked as expected.
722 content:
723 application/json:
724 schema:
725 $ref: '#/components/schemas/EsdbOutput'
726 '400':
727 $ref: '#/components/responses/400Response'
728 '401':
729 $ref: '#/components/responses/401Response'
730 '500':
731 $ref: '#/components/responses/500Response'
732 /us_fema_firm/latest:
733 $ref: '#/paths/~1us_fema_firm~11.0'
734 /us_fema_firm/1.0:
735 post:
736 tags:
737 - Risk lookups
738 summary: U.S. FEMA Firm
739 requestBody:
740 description: Request
741 content:
742 application/json:
743 schema:
744 type: object
745 required:
746 - location
747 properties:
748 location:
749 type: object
750 allOf:
751 - $ref: '#/components/schemas/LocationInput'
752 - type: object
753 properties:
754 address:
755 type: object
756 required:
757 - admin1Code
758 - latitude
759 - longitude
760 - countryRmsCode
761 - rmsGeoModelResolutionCode
762 example:
763 $ref: '#/components/examples/UsFlAddress/value'
764 characteristics:
765 type: object
766 example: {}
767 coverageValues:
768 type: object
769 example: {}
770 layerOptions:
771 type: object
772 properties:
773 distanceUnit:
774 type: "string"
775 enum:
776 - feet
777 - meters
778 description: "Distance unit"
779 default: "feet"
780 proximityDistance:
781 type: "number"
782 format: "double"
783 description: "Return flood zones found within this distance from the address (the maximum distance allowed is 1000 feet)"
784 example: 100
785 default: 100
786 required: true
787 responses:
788 '200':
789 description: Everything worked as expected.
790 content:
791 application/json:
792 schema:
793 $ref: '#/components/schemas/FemaOutput'
794 '400':
795 $ref: '#/components/responses/400Response'
796 '401':
797 $ref: '#/components/responses/401Response'
798 '500':
799 $ref: '#/components/responses/500Response'
800 /us_fl_depth/latest:
801 $ref: '#/paths/~1us_fl_depth~11.0'
802 /us_fl_depth/1.0:
803 post:
804 tags:
805 - Risk lookups
806 summary: U.S. Flood Depth
807 requestBody:
808 description: Request
809 content:
810 application/json:
811 schema:
812 type: object
813 required:
814 - location
815 properties:
816 location:
817 type: object
818 allOf:
819 - $ref: '#/components/schemas/LocationInput'
820 - type: object
821 properties:
822 address:
823 type: object
824 required:
825 - admin1Code
826 - latitude
827 - longitude
828 - countryRmsCode
829 - rmsGeoModelResolutionCode
830 example:
831 $ref: '#/components/examples/UsFlAddress/value'
832 characteristics:
833 type: object
834 example: {}
835 coverageValues:
836 type: object
837 example: {}
838 layerOptions:
839 type: object
840 properties:
841 lookup:
842 type: "string"
843 enum:
844 - floodDepth
845 - wetOrDry
846 - proximity
847 description: >
848 Type of lookup:
849 * `floodDepth` - Lookup flood depths
850 * `wetOrDry` - Lookup if the location is wet or dry
851 * `proximity` - Lookup max depth within proximity
852 default: "floodDepth"
853 example: "proximity"
854 defended:
855 type: boolean
856 description: "Max depth is defended/undefended (only applies to lookup type `proximity`)"
857 returnPeriod:
858 type: integer
859 description: "Return period for max depth calculation (only applies to lookup type `proximity`)"
860 example: 1000
861 proximityDistance:
862 type: "number"
863 format: "double"
864 description: "Return max depth found within this distance from the address (only applies to lookup type `proximity` and the maximum distance allowed is 1000 meters)"
865 example: 100
866 default: 100
867 distanceUnit:
868 type: "string"
869 enum:
870 - feet
871 - meters
872 description: "Distance unit"
873 default: "meters"
874 required: true
875 responses:
876 '200':
877 description: Everything worked as expected.
878 content:
879 application/json:
880 schema:
881 type: object
882 oneOf:
883 - $ref: '#/components/schemas/FlDepthInlandOutput'
884 - $ref: '#/components/schemas/FlDepthBaseOutput'
885 - $ref: '#/components/schemas/FlDepthInlandSurgeProximityOutput'
886 '400':
887 $ref: '#/components/responses/400Response'
888 '401':
889 $ref: '#/components/responses/401Response'
890 '500':
891 $ref: '#/components/responses/500Response'
892 /us_fl_loss_cost/latest:
893 $ref: '#/paths/~1us_fl_loss_cost~11.0'
894 /us_fl_loss_cost/1.0:
895 post:
896 tags:
897 - Risk lookups
898 summary: U.S. Flood Loss Cost
899 requestBody:
900 description: Request
901 content:
902 application/json:
903 schema:
904 type: object
905 required:
906 - location
907 properties:
908 location:
909 type: object
910 allOf:
911 - $ref: '#/components/schemas/LocationInput'
912 - type: object
913 properties:
914 address:
915 type: object
916 required:
917 - admin1Code
918 - latitude
919 - longitude
920 - countryRmsCode
921 - rmsGeoModelResolutionCode
922 - postalCodeGeoId
923 example:
924 $ref: '#/components/examples/UsFlAddressExtended/value'
925 characteristics:
926 example:
927 $ref: '#/components/examples/CharacteristicsFlood/value'
928 coverageValues:
929 example:
930 $ref: '#/components/examples/CoverageValuesFlood/value'
931 layerOptions:
932 type: object
933 properties:
934 deductibleType:
935 type: "integer"
936 description: >
937 Deductible type:
938 * `1` - Building
939 * `2` - Contents
940 * `3` - BI
941 * `4` - Combined
942 * `5` - Site
943 minimum: 1
944 maximum: 5
945 example: 1
946 deductibleAmount:
947 type: "number"
948 format: "double"
949 description: "Deductible amount in %"
950 example: 0.163958568
951 limitAmount:
952 type: "number"
953 format: "double"
954 description: "Limit amount"
955 example: 1888581.191
956 required: true
957 responses:
958 '200':
959 description: Everything worked as expected.
960 content:
961 application/json:
962 schema:
963 $ref: '#/components/schemas/LossCostUsFlOutput'
964 '400':
965 $ref: '#/components/responses/400Response'
966 '401':
967 $ref: '#/components/responses/401Response'
968 '500':
969 $ref: '#/components/responses/500Response'
970 /us_fl_risk_score/latest:
971 $ref: '#/paths/~1us_fl_risk_score~11.0'
972 /us_fl_risk_score/1.0:
973 post:
974 tags:
975 - Risk lookups
976 summary: U.S. Flood Risk Score
977 requestBody:
978 description: Request
979 content:
980 application/json:
981 schema:
982 type: object
983 required:
984 - location
985 properties:
986 location:
987 type: object
988 allOf:
989 - $ref: '#/components/schemas/LocationInput'
990 - type: object
991 properties:
992 address:
993 type: object
994 required:
995 - admin1GeoId
996 - postalCodeGeoId
997 - latitude
998 - longitude
999 - countryRmsCode
1000 - rmsGeoModelResolutionCode
1001 example:
1002 $ref: '#/components/examples/UsFlAddressExtended/value'
1003 characteristics:
1004 example:
1005 $ref: '#/components/examples/CharacteristicsFlood/value'
1006 coverageValues:
1007 type: object
1008 example: {}
1009 required: true
1010 responses:
1011 '200':
1012 description: Everything worked as expected.
1013 content:
1014 application/json:
1015 schema:
1016 $ref: '#/components/schemas/RiskScoreBaseOutput'
1017 '400':
1018 $ref: '#/components/responses/400Response'
1019 '401':
1020 $ref: '#/components/responses/401Response'
1021 '500':
1022 $ref: '#/components/responses/500Response'
1023 /us_fl_susceptibility/latest:
1024 $ref: '#/paths/~1us_fl_susceptibility~11.0'
1025 /us_fl_susceptibility/1.0:
1026 post:
1027 tags:
1028 - Risk lookups
1029 summary: U.S. Flood Susceptibility
1030 requestBody:
1031 description: Request
1032 content:
1033 application/json:
1034 schema:
1035 type: object
1036 required:
1037 - location
1038 properties:
1039 location:
1040 type: object
1041 allOf:
1042 - $ref: '#/components/schemas/LocationInput'
1043 - type: object
1044 properties:
1045 address:
1046 type: object
1047 required:
1048 - admin1GeoId
1049 - postalCodeGeoId
1050 - latitude
1051 - longitude
1052 - countryRmsCode
1053 - rmsGeoModelResolutionCode
1054 example:
1055 $ref: '#/components/examples/UsFlAddressExtended/value'
1056 characteristics:
1057 example:
1058 $ref: '#/components/examples/CharacteristicsFlood/value'
1059 coverageValues:
1060 type: object
1061 example: {}
1062 required: true
1063 responses:
1064 '200':
1065 description: Everything worked as expected.
1066 content:
1067 application/json:
1068 schema:
1069 $ref: '#/components/schemas/FlSusceptibilityOutput'
1070 '400':
1071 $ref: '#/components/responses/400Response'
1072 '401':
1073 $ref: '#/components/responses/401Response'
1074 '500':
1075 $ref: '#/components/responses/500Response'
1076 /us_cs_loss_cost/latest:
1077 $ref: '#/paths/~1us_cs_loss_cost~118.0'
1078 /us_cs_loss_cost/18.0:
1079 post:
1080 tags:
1081 - Risk lookups
1082 summary: U.S. Severe Convective Storm Loss Cost
1083 requestBody:
1084 description: Request
1085 content:
1086 application/json:
1087 schema:
1088 type: object
1089 required:
1090 - location
1091 properties:
1092 location:
1093 type: object
1094 allOf:
1095 - $ref: '#/components/schemas/LocationInput'
1096 - type: object
1097 properties:
1098 address:
1099 type: object
1100 required:
1101 - admin1GeoId
1102 - latitude
1103 - longitude
1104 - countryRmsCode
1105 - rmsGeoModelResolutionCode
1106 example:
1107 $ref: '#/components/examples/UsCsAddress/value'
1108 characteristics:
1109 example:
1110 $ref: '#/components/examples/CharacteristicsBasic/value'
1111 coverageValues:
1112 type: object
1113 example: {}
1114 required: true
1115 responses:
1116 '200':
1117 description: Everything worked as expected.
1118 content:
1119 application/json:
1120 schema:
1121 $ref: '#/components/schemas/CsLossCostOutput'
1122 '400':
1123 $ref: '#/components/responses/400Response'
1124 '401':
1125 $ref: '#/components/responses/401Response'
1126 '500':
1127 $ref: '#/components/responses/500Response'
1128 /us_cs_risk_score/latest:
1129 $ref: '#/paths/~1us_cs_risk_score~118.0'
1130 /us_cs_risk_score/18.0:
1131 post:
1132 tags:
1133 - Risk lookups
1134 summary: U.S. Severe Convective Storm Risk Score
1135 requestBody:
1136 description: Request
1137 content:
1138 application/json:
1139 schema:
1140 type: object
1141 required:
1142 - location
1143 properties:
1144 location:
1145 type: object
1146 allOf:
1147 - $ref: '#/components/schemas/LocationInput'
1148 - type: object
1149 properties:
1150 address:
1151 type: object
1152 required:
1153 - admin1GeoId
1154 - latitude
1155 - longitude
1156 - countryRmsCode
1157 - rmsGeoModelResolutionCode
1158 example:
1159 $ref: '#/components/examples/UsCsAddress/value'
1160 characteristics:
1161 example:
1162 $ref: '#/components/examples/CharacteristicsBasic/value'
1163 coverageValues:
1164 type: object
1165 example: {}
1166 required: true
1167 responses:
1168 '200':
1169 description: Everything worked as expected.
1170 content:
1171 application/json:
1172 schema:
1173 $ref: '#/components/schemas/CsRiskScoreOutput'
1174 '400':
1175 $ref: '#/components/responses/400Response'
1176 '401':
1177 $ref: '#/components/responses/401Response'
1178 '500':
1179 $ref: '#/components/responses/500Response'
1180 /ca_cs_loss_cost/latest:
1181 $ref: '#/paths/~1ca_cs_loss_cost~118.0'
1182 /ca_cs_loss_cost/18.0:
1183 post:
1184 tags:
1185 - Risk lookups
1186 summary: Canada Severe Convective Storm Loss Cost
1187 requestBody:
1188 description: Request
1189 content:
1190 application/json:
1191 schema:
1192 type: object
1193 required:
1194 - location
1195 properties:
1196 location:
1197 type: object
1198 allOf:
1199 - $ref: '#/components/schemas/LocationInput'
1200 - type: object
1201 properties:
1202 address:
1203 type: object
1204 required:
1205 - admin1GeoId
1206 - latitude
1207 - longitude
1208 - countryRmsCode
1209 - rmsGeoModelResolutionCode
1210 example:
1211 $ref: '#/components/examples/CaCsAddress/value'
1212 characteristics:
1213 example:
1214 $ref: '#/components/examples/CharacteristicsBasic/value'
1215 coverageValues:
1216 type: object
1217 example: {}
1218 required: true
1219 responses:
1220 '200':
1221 description: Everything worked as expected.
1222 content:
1223 application/json:
1224 schema:
1225 $ref: '#/components/schemas/CsLossCostOutput'
1226 '400':
1227 $ref: '#/components/responses/400Response'
1228 '401':
1229 $ref: '#/components/responses/401Response'
1230 '500':
1231 $ref: '#/components/responses/500Response'
1232 /ca_cs_risk_score/latest:
1233 $ref: '#/paths/~1ca_cs_risk_score~118.0'
1234 /ca_cs_risk_score/18.0:
1235 post:
1236 tags:
1237 - Risk lookups
1238 summary: Canada Severe Convective Storm Risk Score
1239 requestBody:
1240 description: Request
1241 content:
1242 application/json:
1243 schema:
1244 type: object
1245 required:
1246 - location
1247 properties:
1248 location:
1249 type: object
1250 allOf:
1251 - $ref: '#/components/schemas/LocationInput'
1252 - type: object
1253 properties:
1254 address:
1255 type: object
1256 required:
1257 - admin1GeoId
1258 - latitude
1259 - longitude
1260 - countryRmsCode
1261 - rmsGeoModelResolutionCode
1262 example:
1263 $ref: '#/components/examples/CaCsAddress/value'
1264 characteristics:
1265 example:
1266 $ref: '#/components/examples/CharacteristicsBasic/value'
1267 coverageValues:
1268 type: object
1269 example: {}
1270 required: true
1271 responses:
1272 '200':
1273 description: Everything worked as expected.
1274 content:
1275 application/json:
1276 schema:
1277 $ref: '#/components/schemas/CsRiskScoreOutput'
1278 '400':
1279 $ref: '#/components/responses/400Response'
1280 '401':
1281 $ref: '#/components/responses/401Response'
1282 '500':
1283 $ref: '#/components/responses/500Response'
1284
1285 /us_ws_loss_cost/latest:
1286 $ref: '#/paths/~1us_ws_loss_cost~118.0'
1287 /us_ws_loss_cost/18.1:
1288 $ref: '#/paths/~1us_ws_loss_cost~118.0'
1289 /us_ws_loss_cost/18.0:
1290 post:
1291 tags:
1292 - Risk lookups
1293 summary: U.S. Windstorm Loss Cost
1294 requestBody:
1295 description: Request
1296 content:
1297 application/json:
1298 schema:
1299 type: object
1300 required:
1301 - location
1302 properties:
1303 location:
1304 type: object
1305 allOf:
1306 - $ref: '#/components/schemas/LocationInput'
1307 - type: object
1308 properties:
1309 address:
1310 type: object
1311 required:
1312 - admin1Code
1313 - latitude
1314 - longitude
1315 - countryRmsCode
1316 - rmsGeoModelResolutionCode
1317 example:
1318 $ref: '#/components/examples/UsFlAddress/value'
1319 characteristics:
1320 example:
1321 $ref: '#/components/examples/CharacteristicsBasic/value'
1322 coverageValues:
1323 type: object
1324 example: {}
1325 required: true
1326 responses:
1327 '200':
1328 description: Everything worked as expected.
1329 content:
1330 application/json:
1331 schema:
1332 $ref: '#/components/schemas/LossCostBaseOutput'
1333 '400':
1334 $ref: '#/components/responses/400Response'
1335 '401':
1336 $ref: '#/components/responses/401Response'
1337 '500':
1338 $ref: '#/components/responses/500Response'
1339 /us_ws_risk_score/latest:
1340 $ref: '#/paths/~1us_ws_risk_score~118.0'
1341 /us_ws_risk_score/18.1:
1342 $ref: '#/paths/~1us_ws_risk_score~118.0'
1343 /us_ws_risk_score/18.0:
1344 post:
1345 tags:
1346 - Risk lookups
1347 summary: U.S. Windstorm Risk Score
1348 requestBody:
1349 description: Request
1350 content:
1351 application/json:
1352 schema:
1353 type: object
1354 required:
1355 - location
1356 properties:
1357 location:
1358 type: object
1359 allOf:
1360 - $ref: '#/components/schemas/LocationInput'
1361 - type: object
1362 properties:
1363 address:
1364 type: object
1365 required:
1366 - admin1Code
1367 - latitude
1368 - longitude
1369 - countryRmsCode
1370 - rmsGeoModelResolutionCode
1371 example:
1372 $ref: '#/components/examples/UsFlAddress/value'
1373 characteristics:
1374 example:
1375 $ref: '#/components/examples/CharacteristicsBasic/value'
1376 coverageValues:
1377 type: object
1378 example: {}
1379 required: true
1380 responses:
1381 '200':
1382 description: Everything worked as expected.
1383 content:
1384 application/json:
1385 schema:
1386 $ref: '#/components/schemas/RiskScoreUsOutput'
1387 '400':
1388 $ref: '#/components/responses/400Response'
1389 '401':
1390 $ref: '#/components/responses/401Response'
1391 '500':
1392 $ref: '#/components/responses/500Response'
1393 /us_wt_risk_score/latest:
1394 $ref: '#/paths/~1us_wt_risk_score~118.0'
1395 /us_wt_risk_score/18.0:
1396 post:
1397 tags:
1398 - Risk lookups
1399 summary: U.S. Winterstorm Risk Score
1400 requestBody:
1401 description: Request
1402 content:
1403 application/json:
1404 schema:
1405 type: object
1406 required:
1407 - location
1408 properties:
1409 location:
1410 type: object
1411 allOf:
1412 - $ref: '#/components/schemas/LocationInput'
1413 - type: object
1414 properties:
1415 address:
1416 type: object
1417 required:
1418 - admin1Code
1419 - latitude
1420 - longitude
1421 - countryRmsCode
1422 - rmsGeoModelResolutionCode
1423 example:
1424 $ref: '#/components/examples/UsFlAddress/value'
1425 characteristics:
1426 example:
1427 $ref: '#/components/examples/CharacteristicsBasic/value'
1428 coverageValues:
1429 type: object
1430 example: {}
1431 required: true
1432 responses:
1433 '200':
1434 description: Everything worked as expected.
1435 content:
1436 application/json:
1437 schema:
1438 $ref: '#/components/schemas/RiskScoreUsOutput'
1439 '400':
1440 $ref: '#/components/responses/400Response'
1441 '401':
1442 $ref: '#/components/responses/401Response'
1443 '500':
1444 $ref: '#/components/responses/500Response'
1445 /us_wt_loss_cost/latest:
1446 $ref: '#/paths/~1us_wt_loss_cost~118.0'
1447 /us_wt_loss_cost/18.0:
1448 post:
1449 tags:
1450 - Risk lookups
1451 summary: U.S. Winterstorm Loss Cost
1452 requestBody:
1453 description: Request
1454 content:
1455 application/json:
1456 schema:
1457 type: object
1458 required:
1459 - location
1460 properties:
1461 location:
1462 type: object
1463 allOf:
1464 - $ref: '#/components/schemas/LocationInput'
1465 - type: object
1466 properties:
1467 address:
1468 type: object
1469 required:
1470 - admin1Code
1471 - latitude
1472 - longitude
1473 - countryRmsCode
1474 - rmsGeoModelResolutionCode
1475 example:
1476 $ref: '#/components/examples/UsFlAddress/value'
1477 characteristics:
1478 example:
1479 $ref: '#/components/examples/CharacteristicsBasic/value'
1480 coverageValues:
1481 type: object
1482 example: {}
1483 required: true
1484 responses:
1485 '200':
1486 description: Everything worked as expected.
1487 content:
1488 application/json:
1489 schema:
1490 $ref: '#/components/schemas/LossCostBaseOutput'
1491 '400':
1492 $ref: '#/components/responses/400Response'
1493 '401':
1494 $ref: '#/components/responses/401Response'
1495 '500':
1496 $ref: '#/components/responses/500Response'
1497 /ca_wt_risk_score/latest:
1498 $ref: '#/paths/~1ca_wt_risk_score~118.0'
1499 /ca_wt_risk_score/18.0:
1500 post:
1501 tags:
1502 - Risk lookups
1503 summary: Canada Winterstorm Risk Score
1504 requestBody:
1505 description: Request
1506 content:
1507 application/json:
1508 schema:
1509 type: object
1510 required:
1511 - location
1512 properties:
1513 location:
1514 type: object
1515 allOf:
1516 - $ref: '#/components/schemas/LocationInput'
1517 - type: object
1518 properties:
1519 address:
1520 type: object
1521 required:
1522 - admin1Code
1523 - latitude
1524 - longitude
1525 - countryRmsCode
1526 - rmsGeoModelResolutionCode
1527 example:
1528 $ref: '#/components/examples/CaAddress/value'
1529 characteristics:
1530 example:
1531 $ref: '#/components/examples/CharacteristicsBasic/value'
1532 coverageValues:
1533 type: object
1534 example: {}
1535 required: true
1536 responses:
1537 '200':
1538 description: Everything worked as expected.
1539 content:
1540 application/json:
1541 schema:
1542 $ref: '#/components/schemas/RiskScoreUsOutput'
1543 '400':
1544 $ref: '#/components/responses/400Response'
1545 '401':
1546 $ref: '#/components/responses/401Response'
1547 '500':
1548 $ref: '#/components/responses/500Response'
1549 /ca_wt_loss_cost/latest:
1550 $ref: '#/paths/~1ca_wt_loss_cost~118.0'
1551 /ca_wt_loss_cost/18.0:
1552 post:
1553 tags:
1554 - Risk lookups
1555 summary: Canada Winterstorm Loss Cost
1556 requestBody:
1557 description: Request
1558 content:
1559 application/json:
1560 schema:
1561 type: object
1562 required:
1563 - location
1564 properties:
1565 location:
1566 type: object
1567 allOf:
1568 - $ref: '#/components/schemas/LocationInput'
1569 - type: object
1570 properties:
1571 address:
1572 type: object
1573 required:
1574 - admin1Code
1575 - latitude
1576 - longitude
1577 - countryRmsCode
1578 - rmsGeoModelResolutionCode
1579 example:
1580 $ref: '#/components/examples/CaAddress/value'
1581 characteristics:
1582 example:
1583 $ref: '#/components/examples/CharacteristicsBasic/value'
1584 coverageValues:
1585 type: object
1586 example: {}
1587 required: true
1588 responses:
1589 '200':
1590 description: Everything worked as expected.
1591 content:
1592 application/json:
1593 schema:
1594 $ref: '#/components/schemas/LossCostBaseOutput'
1595 '400':
1596 $ref: '#/components/responses/400Response'
1597 '401':
1598 $ref: '#/components/responses/401Response'
1599 '500':
1600 $ref: '#/components/responses/500Response'
1601 /us_wf_model_hazard/latest:
1602 $ref: '#/paths/~1us_wf_model_hazard~11.0'
1603 /us_wf_model_hazard/1.0:
1604 post:
1605 tags:
1606 - Risk lookups
1607 summary: U.S. Wildfire Distance to Vegetation, Fuel, Slope
1608 requestBody:
1609 description: Request
1610 content:
1611 application/json:
1612 schema:
1613 type: object
1614 required:
1615 - location
1616 properties:
1617 location:
1618 type: object
1619 properties:
1620 address:
1621 type: object
1622 required:
1623 - admin1Code
1624 - latitude
1625 - longitude
1626 - countryRmsCode
1627 - rmsGeoModelResolutionCode
1628 example:
1629 $ref: '#/components/examples/UsCaAddress/value'
1630 required: true
1631 responses:
1632 '200':
1633 description: Everything worked as expected.
1634 content:
1635 application/json:
1636 schema:
1637 $ref: '#/components/schemas/USWildfireOutput'
1638 '400':
1639 $ref: '#/components/responses/400Response'
1640 '401':
1641 $ref: '#/components/responses/401Response'
1642 '500':
1643 $ref: '#/components/responses/500Response'
1644
1645components:
1646 schemas:
1647 GeocodeInput:
1648 type: object
1649 required:
1650 - countryCode
1651 - countryScheme
1652 properties:
1653 id:
1654 type: "integer"
1655 format: "int64"
1656 description: "User defined id"
1657 example: 0
1658 admin1Code:
1659 type: "string"
1660 description: "Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces."
1661 example: "CA"
1662 maxLength: 16
1663 admin1Name:
1664 type: "string"
1665 description: "Name of administrative level 1"
1666 example: "CALIFORNIA"
1667 maxLength: 256
1668 admin2Code:
1669 type: "string"
1670 description: "Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties."
1671 example: "001"
1672 maxLength: 16
1673 admin2Name:
1674 type: "string"
1675 description: "Name of administrative level 2"
1676 example: "ALAMEDA COUNTY"
1677 maxLength: 256
1678 admin3Code:
1679 type: "string"
1680 description: "Code for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts."
1681 example: ""
1682 maxLength: 16
1683 admin3Name:
1684 type: "string"
1685 description: "Name of administrative level 3"
1686 example: ""
1687 maxLength: 256
1688 admin4Code:
1689 type: "string"
1690 description: "Code for administrative level 4"
1691 example: ""
1692 maxLength: 16
1693 admin4Name:
1694 type: "string"
1695 description: "Name of administrative level 4"
1696 example: ""
1697 maxLength: 256
1698 admin5Code:
1699 type: "string"
1700 description: "Code for administrative level 5"
1701 example: ""
1702 maxLength: 16
1703 admin5Name:
1704 type: "string"
1705 description: "Name of administrative level 5"
1706 example: ""
1707 maxLength: 256
1708 cityName:
1709 type: "string"
1710 description: "Name of City/Town"
1711 example: "NEWARK"
1712 maxLength: 256
1713 countryCode:
1714 type: "string"
1715 description: "Country Code"
1716 example: "US"
1717 maxLength: 4
1718 countryName:
1719 type: "string"
1720 description: "Name of Country"
1721 example: "United States"
1722 maxLength: 512
1723 countryScheme:
1724 type: "string"
1725 description: "Standard for user-supplied country code"
1726 example: "ISO2A"
1727 enum:
1728 - ISO2A
1729 - ISO3A
1730 - ISO3N
1731 - FIPS
1732 latitude:
1733 type: "number"
1734 format: "double"
1735 description: "Location Latitude"
1736 example: 37.54120000000001
1737 minimum: -90
1738 maximum: 90
1739 longitude:
1740 type: "number"
1741 format: "double"
1742 description: "Location Longitude"
1743 example: -122.06061000000001
1744 minimum: -180
1745 maximum: 180
1746 postalCode:
1747 type: "string"
1748 description: "Postal Code"
1749 example: "94560"
1750 maxLength: 16
1751 streetAddress:
1752 type: "string"
1753 description: "Address containing Number, Street Name, Street Type, etc."
1754 example: "7575 GATEWAY BLVD"
1755 maxLength: 256
1756 name:
1757 type: "string"
1758 description: "Supplemental text captured for the address"
1759 example: ""
1760 maxLength: 512
1761 GeocodeOutput:
1762 type: object
1763 allOf:
1764 - $ref: '#/components/schemas/GeocodeInput'
1765 - type: object
1766 properties:
1767 admin1GeoId:
1768 type: "integer"
1769 format: "int64"
1770 description: "Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces."
1771 example: 99999106
1772 admin2GeoId:
1773 type: "integer"
1774 format: "int64"
1775 description: "Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties."
1776 example: 99999206001
1777 admin3GeoId:
1778 type: "integer"
1779 format: "int64"
1780 description: "Globally unique ID for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts."
1781 example: 0
1782 cityGeoId:
1783 type: "integer"
1784 format: "int64"
1785 description: "Globally unique ID for City/Town"
1786 example: 999993061080
1787 countryFips:
1788 type: "string"
1789 description: "Country FIPS code"
1790 example: "US"
1791 maxLength: 4
1792 countryGeoId:
1793 type: "integer"
1794 description: "Globally unique ID for Country"
1795 example: 840
1796 countryRmsCode:
1797 type: "string"
1798 description: "RMS code for Country"
1799 example: "US"
1800 maxLength: 4
1801 geoDataSourceId:
1802 type: "integer"
1803 description: "Geocode Data Source ID"
1804 example: 8
1805 geoMatchCode:
1806 type: "string"
1807 description: "Code for portions of the input address that matched, did not match, or were modified during the geocoding process."
1808 example: "T1-999993061080-T1A1-S0T100A100-S1A1-00-B-A-X"
1809 maxLength: 255
1810 locationCode:
1811 type: "string"
1812 description: "Census Tract Number / Sonpo / Sector / Short Postal Code"
1813 example: "060014443.01"
1814 maxLength: 16
1815 locationCodeGeoId:
1816 type: "integer"
1817 format: "int64"
1818 description: "Unique identification code for the location"
1819 example: 0
1820 parcelId:
1821 type: "integer"
1822 format: "int64"
1823 description: "Parcel id"
1824 example: 0
1825 postalCodeGeoId:
1826 type: "integer"
1827 format: "int64"
1828 description: "Globally unique ID for postal code"
1829 example: 99999494560
1830 rmsGeoModelResolutionCode:
1831 type: "integer"
1832 description: >
1833 Address match level:
1834 * `0` - None
1835 * `1` - Coordinate
1836 * `2` - Street / Parcel / Building
1837 * `3` - High Resolution Postcode / Other
1838 * `4` - Block Group/Census Tract
1839 * `5` - Postal code
1840 * `6` - Neighborhood
1841 * `7` - City
1842 * `8` - District / Municipality
1843 * `9` - County
1844 * `10` - State/Province
1845 * `11` - CRESTA
1846 * `12` - Multiple
1847 * `13` - User Defined
1848 * `14` - Country
1849 example: 2
1850 minimum: 0
1851 maximum: 14
1852 rmsGeocodingResolutionCode:
1853 type: "integer"
1854 description: "Indicates the geocoding resolutions that are supported by the ACORD standard"
1855 example: 31
1856 ugid:
1857 type: "string"
1858 description: "Unique global identifier"
1859 example: "USS3121778167575"
1860 maxLength: 50
1861 zone1Code:
1862 type: "string"
1863 description: "CRESTA code"
1864 example: "A2"
1865 maxLength: 16
1866 zone3Code:
1867 type: "string"
1868 description: "Low resolution CRESTA code"
1869 example: ""
1870 maxLength: 16
1871 zone4Code:
1872 type: "string"
1873 description: "High resolution CRESTA code"
1874 example: ""
1875 maxLength: 16
1876 zone1GeoId:
1877 type: "integer"
1878 format: "int64"
1879 description: "Globally unique ID for Zone1 (CRESTA)"
1880 example: 999995062
1881 zone2GeoId:
1882 type: "integer"
1883 format: "int64"
1884 description: "Globally unique ID for Zone2 (CRESTA)"
1885 example: 0
1886 dataVersion:
1887 type: "string"
1888 description: "Data version"
1889 example: "xx.x.xxxx.x"
1890 maxLength: 20
1891 LocationInput:
1892 type: object
1893 required:
1894 - address
1895 properties:
1896 address:
1897 $ref: '#/components/schemas/GeocodeOutput'
1898 characteristics:
1899 $ref: '#/components/schemas/CharacteristicsInput'
1900 coverageValues:
1901 $ref: '#/components/schemas/CoverageValuesInput'
1902 CharacteristicsInput:
1903 type: object
1904 properties:
1905 construction:
1906 type: string
1907 description: "Construction combines both scheme and class. Construction `scheme` (e.g., ATC) is represented by the letters at the beginning. It is a system used for classifying a building's construction class. Construction `class` is represented by the number(s) following the scheme. It is an attribute referring to the dominant material used in constructing the building frame/structure. Unknown=0."
1908 example: "ATC1"
1909 default: "ATC0"
1910 externalDocs:
1911 description: "List of constructions"
1912 url: "https://support.rms.com/techpub/OLH_Content/RLRB_Online_Library/Index.htm#RL_RB_DLM_Ref/Supported_Const_Class_Schemes_by_Country.htm"
1913 occupancy:
1914 type: string
1915 description: "Occupancy combines both scheme and type. Occupancy `scheme` (e.g., ATC) is represented by the letters at the beginning. It is the classification used for identifying a building's occupancy type. Occupancy `type` is represented by the number(s) following the scheme. It is an attribute that describes the typical or dominant use of the building (e.g., residential, or schools, or commercial usage). Unknown=0."
1916 example: "ATC1"
1917 default: "ATC0"
1918 externalDocs:
1919 description: "List of occupancies"
1920 url: "https://support.rms.com/techpub/OLH_Content/RLRB_Online_Library/Index.htm#RL_RB_DLM_Ref/Supported_Occ_Type_Schemes_by_Country.htm"
1921 yearBuilt:
1922 type: "integer"
1923 description: "Attribute describing the year when a structure was constructed. For many RMS peril models, year built is a primary vulnerability attribute."
1924 example: 1980
1925 default: 0
1926 numOfStories:
1927 type: "integer"
1928 description: "Attribute that represents the number of floors for a structure. It is a single number, such as 6 or 22, not a range of numbers. Structures are classified according to the number of floors they have."
1929 default: 0
1930 example: 1
1931 foundationType:
1932 type: "integer"
1933 description: "Attribute that captures this differentiating factor for flood risk. This attribute is used to infer the height of the first floor during hazard retrieval."
1934 default: 0
1935 example: 0
1936 firstFloorHeightAboveGround:
1937 type: "integer"
1938 description: "First floor height above ground"
1939 example: 5
1940 default: 0
1941 basement:
1942 type: "string"
1943 description: "Modifier that represents the level of flood protection for basements"
1944 example: "YES"
1945 default: "DEFAULT"
1946 enum:
1947 - DEFAULT
1948 - YES
1949 - NO
1950 CoverageValuesInput:
1951 type: object
1952 properties:
1953 buildingValue:
1954 type: "number"
1955 format: "double"
1956 description: "Building value"
1957 default: 0
1958 example: 1000000
1959 contentsValue:
1960 type: "number"
1961 format: "double"
1962 description: "Contents value"
1963 default: 0
1964 example: 100000
1965 businessInterruptionValue:
1966 type: "number"
1967 format: "double"
1968 description: "Business interruption value"
1969 default: 0
1970 example: 50000
1971 MmiOutput:
1972 type: object
1973 description: "The Modified Mercalli Intensity (MMI) is a subjective scale used to describe the observed local shaking intensity and related effects of an earthquake. The scale ranges from 1 (barely felt) to 12 (total destruction), with slight damage beginning at 6."
1974 properties:
1975 warnings:
1976 $ref: '#/components/schemas/WarningOutput'
1977 mmi100yr:
1978 type: "number"
1979 format: "double"
1980 description: "100-year MMI score"
1981 example: 0
1982 mmi200yr:
1983 type: "number"
1984 format: "double"
1985 description: "200-year MMI score"
1986 example: 0
1987 mmi250yr:
1988 type: "number"
1989 format: "double"
1990 description: "250-year MMI score"
1991 example: 4.1
1992 mmi475yr:
1993 type: "number"
1994 format: "double"
1995 description: "475-year MMI score"
1996 example: 6.3
1997 mmi500yr:
1998 type: "number"
1999 format: "double"
2000 description: "500-year MMI score"
2001 example: 6.5
2002 mmi1000yr:
2003 type: "number"
2004 format: "double"
2005 description: "1000-year MMI score"
2006 example: 8.0
2007 mmi1500yr:
2008 type: "number"
2009 format: "double"
2010 description: "1500-year MMI score"
2011 example: 8.5
2012 EsdbOutput:
2013 type: object
2014 description: "results"
2015 properties:
2016 warnings:
2017 $ref: '#/components/schemas/WarningOutput'
2018 id:
2019 type: "integer"
2020 description: "Client location id for purposes of matching input and output"
2021 example: 1234
2022 multipleBuildingFlag:
2023 type: "string"
2024 description: "Potential for multiple buildings"
2025 example: "Unknown"
2026 isPrimaryBuildingFlag:
2027 type: "integer"
2028 description: "Represents the building to be returned when multiple buildings exist. Yes=1; No=0"
2029 example: 0
2030 isHD:
2031 type: "integer"
2032 description: "Indicates whether the record is part of HD data set"
2033 example: 0
2034 numOfStories:
2035 type: "integer"
2036 description: "Attribute that represents the number of floors for a structure. It is a single number, such as 6 or 22, not a range of numbers. Structures are classified according to the number of floors they have."
2037 example: 3
2038 numOfStoriesSource:
2039 type: "string"
2040 description: "Flag for source of numOfStories data returned"
2041 example: "E"
2042 floorArea:
2043 type: "integer"
2044 description: "Floor area is a primary building characteristic that represents a building's total living area, across all floors. It excludes garages, porches, decks, sunrooms, and basements."
2045 example: 1452
2046 floorAreaSource:
2047 type: "string"
2048 description: "Flag for source of floorArea data returned"
2049 example: "E"
2050 yearBuilt:
2051 type: "integer"
2052 description: "Attribute describing the year when a structure was constructed. For many RMS peril models, year built is a primary vulnerability attribute."
2053 example: 1965
2054 yearBuiltSource:
2055 type: "string"
2056 description: "Flag for source of yearBuilt data returned"
2057 example: "E"
2058 buildingHeight:
2059 type: "integer"
2060 description: "Building Height in feet"
2061 example: 400
2062 construction:
2063 type: "string"
2064 description: "Construction combines both scheme and class. Construction `scheme` (e.g., ATC) is represented by the letters at the beginning. It is a system used for classifying a building's construction class. Construction `class` is represented by the number(s) following the scheme. It is an attribute referring to the dominant material used in constructing the building frame/structure. Unknown=0."
2065 example: "ATC1"
2066 constructionSource:
2067 type: "string"
2068 description: "Flag for source of construction data returned "
2069 example: "E"
2070 occupancy:
2071 type: "string"
2072 description: "Occupancy combines both scheme and type. Occupancy `scheme` (e.g., ATC) is represented by the letters at the beginning. It is the classification used for identifying a building's occupancy type. Occupancy `type` is represented by the number(s) following the scheme. It is an attribute that describes the typical or dominant use of the building (e.g., residential, or schools, or commercial usage). Unknown=0."
2073 example: "ATC1"
2074 occupancySource:
2075 type: "string"
2076 description: "Flag for source of occupancy data returned "
2077 example: "E"
2078 occupancy2: #Is secondaryOccupancy in the spec
2079 type: "string"
2080 description: "Second Occupancy Scheme and Code"
2081 example: "ATC2"
2082 occupancy3: #Is tertiaryOccupancy in the spec
2083 type: "string"
2084 description: "Third Occupancy Scheme and Code"
2085 example: "ATC3"
2086 roofCoverCode:
2087 type: "string"
2088 description: "Code for modifier that captures the presence of roof covering that affects losses depending on the uplift resistance of the roof cover elements and their replacement costs."
2089 example: "RMS7"
2090 roofCoverDescription:
2091 type: "string"
2092 description: "Roofing material description"
2093 example: "COMPOSITION SHINGLE"
2094 airConditioningDescription:
2095 type: "string"
2096 description: "Air conditioning description"
2097 example: "CENTRAL"
2098 exteriorDescription:
2099 type: "string"
2100 description: "Modifier that describes the exterior of the building (cladding) with respect to its damageability and performance in earthquakes, floods, severe convective storms, and windstorms."
2101 example: "BRICK VENEER"
2102 roofGeometryCode:
2103 type: "string"
2104 description: "Code for modifier that captures the roof geometry, which determines the magnitude and extent of wind forces experienced on the roof."
2105 example: "4"
2106 roofGeometryDescription:
2107 type: "string"
2108 description: "Roof Geometry description"
2109 example: "Gable roof high pitch (>30ยบ)"
2110 floorOccupancy:
2111 type: "string"
2112 description: "Modifier used in RMS products that captures the number of floors occupied, either a single floor or a range of floors. Positive numbers represent floors above grade, and negative numbers represent floors below grade (basement levels)."
2113 example: "-1"
2114 floorOccupancyDescription:
2115 type: "string"
2116 description: "Basement description"
2117 example: "Finished"
2118 foundationSystemDescription:
2119 type: "string"
2120 description: "Attribute that captures this differentiating factor for flood risk. This attribute is used to infer the height of the first floor during hazard retrieval."
2121 example: "POST AND PIER"
2122 heatingTypeDescription:
2123 type: "string"
2124 description: "Type of heating"
2125 example: "CENTRAL"
2126 numberOfBaths:
2127 type: "string"
2128 description: "Count of bathrooms"
2129 example: "2"
2130 numberOfBedrooms:
2131 type: "string"
2132 description: "Count of bedrooms"
2133 example: "3"
2134 numberOfUnits:
2135 type: "string"
2136 description: "Count of units in building (if MFD)"
2137 example: "1"
2138 pool:
2139 type: "string"
2140 description: "Presence of Pool"
2141 example: "NOT PRESENT"
2142 garagingDescription:
2143 type: "string"
2144 description: "Modifier that captures the presence of garages to specify where automobiles are parked and the relative protection from hail and similar hazards."
2145 example: "GARAGE - ATTACHED"
2146 buildingValuationUpperRange:
2147 type: "integer"
2148 description: "Maximum probable building value for given property"
2149 example: 210000
2150 buildingValuationLowerRange:
2151 type: "integer"
2152 description: "Minimum probable building value for given property"
2153 example: 180000
2154 currencyCode:
2155 type: "string"
2156 description: "Currency of valuation. Two- or three-letter ISO code used to represent an individual currency."
2157 example: "USD"
2158 versionId:
2159 type: "number"
2160 format: "double"
2161 description: "ESDB version id"
2162 example: 7.1
2163 CsRiskScoreOutput:
2164 type: object
2165 description: "results"
2166 properties:
2167 warnings:
2168 $ref: '#/components/schemas/WarningOutput'
2169 score50yr:
2170 type: "number"
2171 format: "integer"
2172 description: "The combined Risk Score at the 1 in 50 return period"
2173 example: 1
2174 score100yr:
2175 type: "number"
2176 format: "integer"
2177 description: "The combined Risk Score at the 1 in 100 return period"
2178 example: 1
2179 score250yr:
2180 type: "number"
2181 format: "integer"
2182 description: "The combined Risk Score at the 1 in 250 return period"
2183 example: 1
2184 scoreOverall:
2185 type: "number"
2186 format: "integer"
2187 description: "The combined Risk Score at the 1 in 100 return period"
2188 example: 1
2189 dominantSubperil:
2190 type: "number"
2191 format: "double"
2192 description: "The dominant sub-peril driving the combined Risk Score at the 1 in 100 return period - 1=Hail, 2=Tornado, 3=Wind, 0=no dominant peril (because 2 or 3 perils have the same value - very unlikely, but to handle this eventuality for completeness)"
2193 example: 1.1
2194 percentileAdmin1:
2195 type: "number"
2196 format: "double"
2197 description: "Percentile in State"
2198 example: 1.1
2199 CsLossCostOutput:
2200 type: object
2201 description: "`Loss cost`, also known as average annual loss (AAL), is derived using RMS models and account for hazard and vulnerability from detailed loss modeling of the peril region. To produce an annualized loss, losses from every event affecting each location are multiplied by the annual rate (probability) of the hazards causing that loss. The sum of the annualized losses at each location produces the AAL for that location, which is normalized by the exposure to yield the `annualized loss rate` (ALR). This calculation is performed for buildings, contents, and business interruption coverages. Total insured values (TIVs) for the relevant coverage are then applied to give the loss cost for each coverage."
2202 allOf:
2203 - $ref: '#/components/schemas/LossCostBaseOutput'
2204 - type: object
2205 properties:
2206 buildingAlrHail:
2207 type: "number"
2208 format: "double"
2209 description: "The annualized loss rate for Buildings coverage for hail"
2210 example: 1.1
2211 contentsAlrHail:
2212 type: "number"
2213 format: "double"
2214 description: "The annualized loss rate for Contents coverage for hail"
2215 example: 1.1
2216 businessInterruptionAlrHail:
2217 type: "number"
2218 format: "double"
2219 description: "The annualized loss rate for BI coverage for hail"
2220 example: 1.1
2221 buildingAlrTornado:
2222 type: "number"
2223 format: "double"
2224 description: "The annualized loss rate for Buildings coverage for tornado"
2225 example: 1.1
2226 contentsAlrTornado:
2227 type: "number"
2228 format: "double"
2229 description: "The annualized loss rate for Contents coverage for tornado"
2230 example: 1.1
2231 businessInterruptionAlrTornado:
2232 type: "number"
2233 format: "double"
2234 description: "The annualized loss rate for BI coverage for tornado"
2235 example: 1.1
2236 buildingAlrWind:
2237 type: "number"
2238 format: "double"
2239 description: "The annualized loss rate for Buildings coverage for wind"
2240 example: 1.1
2241 businessInterruptionAlrWind:
2242 type: "number"
2243 format: "double"
2244 description: "The annualized loss rate for BI coverage for wind"
2245 example: 1.1
2246 contentsAlrWind:
2247 type: "number"
2248 format: "double"
2249 description: "The annualized loss rate for Contents coverage for wind"
2250 example: 1.1
2251 FlSusceptibilityOutput:
2252 type: object
2253 description: "results"
2254 properties:
2255 warnings:
2256 $ref: '#/components/schemas/WarningOutput'
2257 dtmElevation:
2258 type: "number"
2259 format: "double"
2260 description: "DTM elevation"
2261 example: 108.07087
2262 firstFloorHeightAboveGround:
2263 type: "integer"
2264 description: "Captures the height of first finished floor above ground in feet"
2265 example: 2
2266 percentBasement:
2267 type: "number"
2268 format: "double"
2269 description: "Basement likelihood for a location is a percentage. The presence of basement floors in a building can significantly increase flood losses, particularly in high-rise commercial buildings, which can have high contents value in basements."
2270 example: 0.05
2271 FlDepthBaseOutput:
2272 type: object
2273 description: "results for `wetOrDry` lookup"
2274 properties:
2275 warnings:
2276 $ref: '#/components/schemas/WarningOutput'
2277 status:
2278 type: "string"
2279 description: "Status"
2280 enum:
2281 - NOT FLOODED
2282 - FLOODED
2283 example: "FLOODED"
2284 FlDepthInlandProximityOutput:
2285 type: object
2286 allOf:
2287 - $ref: '#/components/schemas/FlDepthBaseOutput'
2288 - type: object
2289 description: "results for `proximity` lookup"
2290 properties:
2291 maxDepthWithinRadius:
2292 type: "integer"
2293 description: "Max depth within radius"
2294 example: 1
2295 FlDepthInlandSurgeProximityOutput:
2296 type: object
2297 allOf:
2298 - $ref: '#/components/schemas/FlDepthInlandProximityOutput'
2299 - type: object
2300 description: "results for `proximity` lookup"
2301 properties:
2302 dominantFloodSource:
2303 type: "string"
2304 description: "Dominant flood source"
2305 enum:
2306 - INLAND
2307 - SURGE
2308 example: "INLAND"
2309 FlDepthInlandOutput:
2310 type: object
2311 allOf:
2312 - $ref: '#/components/schemas/FlDepthBaseOutput'
2313 - type: object
2314 description: "results for `floodDepth` lookup"
2315 properties:
2316 depthInlandUndef30yr:
2317 type: "integer"
2318 description: "Depth inland undefended 30-year"
2319 example: 4
2320 depthInlandDef30yr:
2321 type: "integer"
2322 description: "Depth inland defended 30-year"
2323 example: 3
2324 depthInlandUndef50yr:
2325 type: "integer"
2326 description: "Depth inland undefended 50-year"
2327 example: 5
2328 depthInlandDef50yr:
2329 type: "integer"
2330 description: "Depth inland defended 50-year"
2331 example: 3
2332 depthInlandUndef100yr:
2333 type: "integer"
2334 description: "Depth inland undefended 100-year"
2335 example: 5
2336 depthInlandDef100yr:
2337 type: "integer"
2338 description: "Depth inland defended 100-year"
2339 example: 5
2340 depthInlandUndef200yr:
2341 type: "integer"
2342 description: "Depth inland undefended 200-year"
2343 example: 6
2344 depthInlandDef200yr:
2345 type: "integer"
2346 description: "Depth inland defended 200-year"
2347 example: 6
2348 depthInlandUndef250yr:
2349 type: "integer"
2350 description: "Depth inland undefended 250-year"
2351 example: 6
2352 depthInlandDef250yr:
2353 type: "integer"
2354 description: "Depth inland defended 250-year"
2355 example: 6
2356 depthInlandUndef500yr:
2357 type: "integer"
2358 description: "Depth inland undefended 500-year"
2359 example: 6
2360 depthInlandDef500yr:
2361 type: "integer"
2362 description: "Depth inland defended 500-year"
2363 example: 6
2364 depthInlandUndef1000yr:
2365 type: "integer"
2366 description: "Depth inland undefended 1000-year"
2367 example: 6
2368 depthInlandDef1000yr:
2369 type: "integer"
2370 description: "Depth inland defended 1000-year"
2371 example: 6
2372 FlDepthInlandSurgeOutput:
2373 type: object
2374 allOf:
2375 - $ref: '#/components/schemas/FlDepthInlandOutput'
2376 - type: object
2377 description: "results for `floodDepth` lookup"
2378 properties:
2379 depthSurgeUndef30yr:
2380 type: "integer"
2381 description: "Depth surge undefended 30-year"
2382 example: 0
2383 depthSurgeDef30yr:
2384 type: "integer"
2385 description: "Depth surge defended 30-year"
2386 example: 0
2387 depthSurgeUndef50yr:
2388 type: "integer"
2389 description: "Depth surge undefended 50-year"
2390 example: 0
2391 depthSurgeDef50yr:
2392 type: "integer"
2393 description: "Depth surge defended 50-year"
2394 example: 0
2395 depthSurgeUndef100yr:
2396 type: "integer"
2397 description: "Depth surge undefended 100-year"
2398 example: 0
2399 depthSurgeDef100yr:
2400 type: "integer"
2401 description: "Depth surge defended 100-year"
2402 example: 0
2403 depthSurgeUndef200yr:
2404 type: "integer"
2405 description: "Depth surge undefended 200-year"
2406 example: 0
2407 depthSurgeDef200yr:
2408 type: "integer"
2409 description: "Depth surge defended 200-year"
2410 example: 0
2411 depthSurgeUndef250yr:
2412 type: "integer"
2413 description: "Depth surge undefended 250-year"
2414 example: 0
2415 depthSurgeDef250yr:
2416 type: "integer"
2417 description: "Depth surge defended 250-year"
2418 example: 0
2419 depthSurgeUndef500yr:
2420 type: "integer"
2421 description: "Depth surge undefended 500-year"
2422 example: 0
2423 depthSurgeDef500yr:
2424 type: "integer"
2425 description: "Depth surge defended 500-year"
2426 example: 0
2427 depthSurgeUndef1000yr:
2428 type: "integer"
2429 description: "Depth surge undefended 1000-year"
2430 example: 0
2431 depthSurgeDef1000yr:
2432 type: "integer"
2433 description: "Depth surge defended 1000-year"
2434 example: 0
2435 depthCombinedUndef30yr:
2436 type: "integer"
2437 description: "Depth combined undefended 30-year"
2438 example: 4
2439 depthCombinedDef30yr:
2440 type: "integer"
2441 description: "Depth combined defended 30-year"
2442 example: 3
2443 depthCombinedUndef50yr:
2444 type: "integer"
2445 description: "Depth combined undefended 50-year"
2446 example: 5
2447 depthCombinedDef50yr:
2448 type: "integer"
2449 description: "Depth combined defended 50-year"
2450 example: 3
2451 depthCombinedUndef100yr:
2452 type: "integer"
2453 description: "Depth combined undefended 100-year"
2454 example: 5
2455 depthCombinedDef100yr:
2456 type: "integer"
2457 description: "Depth combined defended 100-year"
2458 example: 5
2459 depthCombinedUndef200yr:
2460 type: "integer"
2461 description: "Depth combined undefended 200-year"
2462 example: 6
2463 depthCombinedDef200yr:
2464 type: "integer"
2465 description: "Depth combined defended 200-year"
2466 example: 6
2467 depthCombinedUndef250yr:
2468 type: "integer"
2469 description: "Depth combined undefended 250-year"
2470 example: 6
2471 depthCombinedDef250yr:
2472 type: "integer"
2473 description: "Depth combined defended 250-year"
2474 example: 6
2475 depthCombinedUndef500yr:
2476 type: "integer"
2477 description: "Depth combined undefended 500-year"
2478 example: 6
2479 depthCombinedDef500yr:
2480 type: "integer"
2481 description: "Depth combined defended 500-year"
2482 example: 6
2483 depthCombinedUndef1000yr:
2484 type: "integer"
2485 description: "Depth combined undefended 1000-year"
2486 example: 6
2487 depthCombinedDef1000yr:
2488 type: "integer"
2489 description: "Depth combined defended 1000-year"
2490 example: 6
2491 FemaOutput:
2492 type: object
2493 description: "results"
2494 properties:
2495 warnings:
2496 $ref: '#/components/schemas/WarningOutput'
2497 panel:
2498 type: "string"
2499 description: "Numeric designation used to identify the FIRM Map associated with a given area. First six digits are the FEMA community number."
2500 example: "12095C0265F"
2501 community:
2502 type: "string"
2503 description: "Political entity with the authority to adopt and enforce floodplain ordinances for the area under its jurisdiction. Community number is a unique six-digit number assigned by FEMA and used for identity in computer databases."
2504 example: "120186"
2505 floodZone:
2506 type: "string"
2507 description: "FEMA issues Flood Insurance Rate Maps (FIRMs) with official flood zone designations for the purpose of rating flood policies."
2508 example: "X"
2509 sfha:
2510 type: "string"
2511 description: "Special Flood Hazard Area (SFHA) is an area at high risk for flooding as determined by FEMA Flood Insurance Rate Maps (FIRMs). This is an area with a 1% annual chance of flooding. "
2512 enum:
2513 - Yes
2514 - No
2515 example: "No"
2516 panelDate:
2517 type: "string"
2518 format: "date"
2519 description: "Panel date is the date recorded in the FEMA FMSIS database, which is associated with the given panel number."
2520 example: "2009-09-25"
2521 bfe:
2522 type: "integer"
2523 description: "Base Flood Elevation is defined by FEMA as the height of the base (100-year) flood in relation to a specified datum, usually the National Geodetic Vertical Datum of 1929 (NGVD 29) or North American Vertical Datum of 1988 (NAVD 88), in feet."
2524 example: -999
2525 default: -999
2526 annualProbability:
2527 type: "string"
2528 description: "Annual probability"
2529 example: "Less than 0.2%"
2530 levees:
2531 type: "string"
2532 description: "Flood defenses can flood walls, levees, dykes, and embankments—typically designed to protect against a flood of a certain return period."
2533 enum:
2534 - Yes
2535 - No
2536 example: "No"
2537 otherZones:
2538 type: "string"
2539 description: "Other zones (within proximity distance)"
2540 example: ""
2541 flMatch:
2542 type: "string"
2543 description: "Fl match"
2544 example: "1"
2545 floodway:
2546 type: "string"
2547 description: "Any land area susceptible to being inundated by floodwaters from any source."
2548 enum:
2549 - Yes
2550 - No
2551 example: "No"
2552 cobra:
2553 type: "string"
2554 description: "The Coastal Barrier Resources Act of 1982 (COBRA) designated certain portions of the Gulf and East Coasts as undeveloped coastal barriers."
2555 enum:
2556 - Yes
2557 - No
2558 example: "No"
2559 RiskScoreBaseOutput:
2560 type: object
2561 description: "results"
2562 properties:
2563 warnings:
2564 $ref: '#/components/schemas/WarningOutput'
2565 score100yr:
2566 type: "integer"
2567 description: "100-year score"
2568 example: 1
2569 score250yr:
2570 type: "integer"
2571 description: "250-year score"
2572 example: 1
2573 score500yr:
2574 type: "integer"
2575 description: "500-year score"
2576 example: 3
2577 scoreOverall:
2578 type: "integer"
2579 description: "Overall score"
2580 example: 3
2581 RiskScoreUsOutput:
2582 type: object
2583 allOf:
2584 - $ref: '#/components/schemas/RiskScoreBaseOutput'
2585 - type: object
2586 properties:
2587 percentileAdmin1:
2588 type: "number"
2589 format: "double"
2590 description: "Riskiness compared to other locations in the Admin1"
2591 example: 0.0085084662
2592 RiskScoreEuOutput:
2593 type: object
2594 allOf:
2595 - $ref: '#/components/schemas/RiskScoreBaseOutput'
2596 - type: object
2597 properties:
2598 percentileCountry:
2599 type: "number"
2600 format: "double"
2601 description: "Riskiness compared to other locations in the Country"
2602 example: 0.0085084662
2603 LossCostBaseOutput:
2604 type: object
2605 description: "`Loss cost`, also known as average annual loss (AAL), is derived using RMS models and account for hazard and vulnerability from detailed loss modeling of the peril region. To produce an annualized loss, losses from every event affecting each location are multiplied by the annual rate (probability) of the hazards causing that loss. The sum of the annualized losses at each location produces the AAL for that location, which is normalized by the exposure to yield the `annualized loss rate` (ALR). This calculation is performed for buildings, contents, and business interruption coverages. Total insured values (TIVs) for the relevant coverage are then applied to give the loss cost for each coverage."
2606 properties:
2607 warnings:
2608 $ref: '#/components/schemas/WarningOutput'
2609 buildingAlr:
2610 type: "number"
2611 format: "double"
2612 description: "Building annualized loss rate"
2613 example: 0.000863401691354315
2614 contentsAlr:
2615 type: "number"
2616 format: "double"
2617 description: "Contents annualized loss rate"
2618 example: 0.000358529682823589
2619 businessInterruptionAlr:
2620 type: "number"
2621 format: "double"
2622 description: "Business interruption annualized loss rate"
2623 example: 0.000559604863156912
2624 LossCostOutput:
2625 type: object
2626 allOf:
2627 - $ref: '#/components/schemas/LossCostBaseOutput'
2628 - type: object
2629 properties:
2630 grossLoss:
2631 type: "number"
2632 format: "double"
2633 description: "Loss to the insurer, accounting for the application of all insurance terms but without consideration for any reinsurance recoveries"
2634 example: 750.16
2635 groundUpLoss:
2636 type: "number"
2637 format: "double"
2638 description: "Total loss to the exposure, independent of any insurance or reinsurance terms"
2639 example: 901.43
2640 LossCostUsFlOutput:
2641 type: object
2642 allOf:
2643 - $ref: '#/components/schemas/LossCostOutput'
2644 - type: object
2645 properties:
2646 contentsAlrFlood:
2647 type: "number"
2648 format: "double"
2649 description: "Flood contents annualized loss rate"
2650 example: 5.308397E-4
2651 contentsAlrSurge:
2652 type: "number"
2653 format: "double"
2654 description: "Surge contents annualized loss rate"
2655 example: 0.0
2656 buildingAlrFlood:
2657 type: "number"
2658 format: "double"
2659 description: "Flood building annualized loss rate"
2660 example: 3.419841E-4
2661 buildingAlrSurge:
2662 type: "number"
2663 format: "double"
2664 description: "Surge building annualized loss rate"
2665 example: 0.
2666 businessInterruptionAlrFlood:
2667 type: "number"
2668 format: "double"
2669 description: "Flood business interruption annualized loss rate"
2670 example: 3.260721E-4
2671 businessInterruptionAlrSurge:
2672 type: "number"
2673 format: "double"
2674 description: "Surge business interruption annualized loss rate"
2675 example: 0.0
2676 USWildfireOutput:
2677 type: object
2678 allOf:
2679 - $ref: '#/components/schemas/USWildfireOutput'
2680 - type: object
2681 properties:
2682 fuelCodeDescription:
2683 type: "string"
2684 description: "Fuel Type Description"
2685 example: "Short Grass (1 foot)"
2686 slopeInPercent:
2687 type: "number"
2688 format: "integer"
2689 description: "Slope in percent"
2690 example: 3
2691 distanceToVegetationUnit:
2692 type: "string"
2693 description: "Distance to Vegetation Unit"
2694 example: "feet"
2695 distanceToVegetation:
2696 type: "string"
2697 description: "Distance to Vegetation"
2698 example: "5"
2699 fuelCode:
2700 type: "number"
2701 format: "integer"
2702 description: "Fuel Type Code"
2703 example: 1
2704 CompositeOutput:
2705 type: array
2706 description: "results"
2707 items:
2708 type: object
2709 properties:
2710 name:
2711 type: "string"
2712 description: "Layer name"
2713 example: "geocode"
2714 version:
2715 type: "string"
2716 description: "Layer version"
2717 example: "latest"
2718 results:
2719 type: object
2720 additionalProperties:
2721 type: object
2722 description: "For result fields, see the individual layer documentation"
2723 errors:
2724 type: array
2725 items:
2726 $ref: '#/components/schemas/ErrorItem'
2727 CompositeInput:
2728 type: object
2729 required:
2730 - location
2731 - layers
2732 properties:
2733 location:
2734 $ref: '#/components/schemas/LocationInput'
2735 layers:
2736 type: array
2737 items:
2738 type: object
2739 required:
2740 - name
2741 - version
2742 properties:
2743 name:
2744 type: "string"
2745 description: "Layer name"
2746 example: "geocode"
2747 version:
2748 type: "string"
2749 description: "Layer version"
2750 example: "latest"
2751 options:
2752 description: "Layer options"
2753 type: object
2754 additionalProperties:
2755 type: string
2756 GenericInput:
2757 type: object
2758 required:
2759 - location
2760 properties:
2761 location:
2762 $ref: '#/components/schemas/LocationInput'
2763 layerOptions:
2764 type: array
2765 items:
2766 type: object
2767 additionalProperties:
2768 type: object
2769 description: "For result fields, see the individual layer documentation"
2770 GenericOutput:
2771 type: object
2772 description: "results"
2773 additionalProperties:
2774 type: string
2775 WarningItem:
2776 type: object
2777 properties:
2778 code:
2779 type: string
2780 example: "FLG_XXXX"
2781 description: |
2782 Warning codes:
2783 | Code | Description |
2784 |-----|-----|
2785 | FLG_4001 | Hazard values are calculated based on default value for %%% |
2786 | FLG_4101 | Hazard values are calculated based on default floodDepth |
2787 | FLG_4102 | Hazard values are calculated based on maximum proximityDistance |
2788 | FLG_4103 | No additional options can be provided to this lookup %%% |
2789 | FLG_4201 | Location not matched in ESDB building attributes database |
2790 | FLG_4202 | Location is not eligible for ESDB building attribute return. Client input occupancy does not match ESDB occupancy |
2791 | FLG_4203 | Location matched in ESDB building attributes database. Where values are not populated, they are not available in database |
2792 | FLG_4204 | Insufficient geocoding information. Lookup will proceed with default value for %%% |
2793 | FLG_4205 | The geocoding version used is not recommended for this layer. |
2794 | FLG_4300 | Deductible amount is required |
2795 | FLG_4301 | No coverage values provided. Cannot calculate ground-up and gross loss. |
2796 | FLG_4302 | Invalid / no deductible information entered |
2797 | FLG_4303 | Area not covered in FEMA data |
2798 message:
2799 type: string
2800 example: "Warning message"
2801 WarningOutput:
2802 type: array
2803 items:
2804 $ref: '#/components/schemas/WarningItem'
2805 ErrorItem:
2806 type: object
2807 properties:
2808 code:
2809 type: string
2810 example: "ERR_XXXX"
2811 description: |
2812 Error codes:
2813 | Code | Description |
2814 |-----|-----|
2815 | ERR_4000 | Bad request |
2816 | ERR_4001 | Insufficient geocoding information. This required field is missing %%% |
2817 | ERR_4002 | Insufficient geocoding resolution to look up requested data |
2818 | ERR_4003 | Location is in a region that is not supported by this hazard layer %%% |
2819 | ERR_4005 | Insufficient information to look up requested data |
2820 | ERR_4010 | Forbidden |
2821 | ERR_4030 | Unauthorized |
2822 | ERR_4041 | Invalid input %%% |
2823 | ERR_4100 | %%% is not a valid lookup type. Valid lookups are 'wetOrDry', 'floodDepth', and 'proximity' |
2824 | ERR_4101 | %%% is not a valid distanceUnit option. Valid distanceUnits are 'meters' and 'feet' |
2825 | ERR_4102 | %%% is not a valid returnPeriod option. Valid returnPeriods are 30, 50, 100, 200, 250, 500, and 1000. |
2826 | ERR_4103 | %%% is not a valid defended option. Valid defended options are 'true' and 'false' |
2827 | ERR_4104 | %%% is not a valid proximityDistance option. Valid proximityDistance is a positive number |
2828 | ERR_4300 | Invalid basement type provided. Valid values are yes / no or default |
2829 | ERR_4301 | Invalid deductible type provided. Valid values are 1 to 5 |
2830 | ERR_4302 | Deductible amount can be between 0 and 1, where 1 means 100% |
2831 | ERR_4400 | Geocoding error |
2832 | ERR_4401 | Invalid address input %%% field is incorrect |
2833 | ERR_5000 | Internal server error |
2834 message:
2835 type: string
2836 example: "Error message"
2837 ErrorOutput:
2838 type: object
2839 properties:
2840 contextId:
2841 type: string
2842 example: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2843 additionalInfo:
2844 type: string
2845 example: ""
2846 errors:
2847 type: array
2848 items:
2849 $ref: '#/components/schemas/ErrorItem'
2850 securitySchemes:
2851 apiKey:
2852 type: http
2853 scheme: bearer
2854 bearerFormat: JWT
2855 examples:
2856 CaAddress:
2857 value:
2858 countryCode: "CA"
2859 countryScheme: "ISO2A"
2860 countryRmsCode: "CA"
2861 admin1Code: "AB"
2862 latitude: 53.55
2863 longitude: -113.35
2864 rmsGeoModelResolutionCode: 1
2865 NzAddress:
2866 value:
2867 countryCode: "NZ"
2868 countryScheme: "ISO2A"
2869 countryRmsCode: "NZ"
2870 latitude: -36.84491
2871 longitude: 174.7335
2872 rmsGeoModelResolutionCode: 1
2873 UsCaAddress:
2874 value:
2875 countryCode: "US"
2876 countryScheme: "ISO2A"
2877 countryRmsCode: "US"
2878 admin1Code: "CA"
2879 latitude: 37.54120000000001
2880 longitude: -122.06061000000001
2881 rmsGeoModelResolutionCode: 1
2882 UsTxAddressEsdb:
2883 value:
2884 countryCode: "US"
2885 countryScheme: "ISO2A"
2886 countryRmsCode: "US"
2887 admin1Code: "TX"
2888 rmsGeoModelResolutionCode: 2
2889 geoMatchCode: "K6-99999783726670-K1T1P1A1-K95T100P100A100-T1P1A1-00-AB-TP-X"
2890 cityName: "SPICEWOOD"
2891 streetAddress: "1900 LAS ENTRADAS"
2892 UsFlAddress:
2893 value:
2894 countryCode: "US"
2895 countryScheme: "ISO2A"
2896 countryRmsCode: "US"
2897 admin1Code: "FL"
2898 latitude: 28.514108
2899 longitude: -81.37189
2900 rmsGeoModelResolutionCode: 1
2901 UsFlAddressExtended:
2902 value:
2903 countryCode: "US"
2904 countryScheme: "ISO2A"
2905 countryRmsCode: "US"
2906 admin1Code: "FL"
2907 latitude: 28.514108
2908 longitude: -81.37189
2909 rmsGeoModelResolutionCode: 1
2910 postalCodeGeoId: 99999432806
2911 admin1GeoId: 99999112
2912 UsCsAddress:
2913 value:
2914 countryCode: "US"
2915 countryScheme: "ISO2A"
2916 countryRmsCode: "US"
2917 admin1Code: "ME"
2918 latitude: 45.75
2919 longitude: -67.25
2920 rmsGeoModelResolutionCode: 1
2921 postalCodeGeoId: 99999404491
2922 admin1GeoId: 99999123
2923 CaCsAddress:
2924 value:
2925 countryCode: "CA"
2926 countryScheme: "ISO2A"
2927 countryRmsCode: "CA"
2928 admin1Code: "QC"
2929 latitude: 51.25
2930 longitude: -63.25
2931 rmsGeoModelResolutionCode: 1
2932 postalCodeGeoId: 23803454
2933 admin1GeoId: 2344924
2934 EuGbAddress:
2935 value:
2936 countryCode: "GB"
2937 countryScheme: "ISO2A"
2938 countryRmsCode: "GB"
2939 latitude: 54.988537
2940 longitude: -2.138128
2941 rmsGeoModelResolutionCode: 1
2942 EuGrAddress:
2943 value:
2944 countryCode: "GR"
2945 countryScheme: "ISO2A"
2946 countryRmsCode: "GR"
2947 latitude: 38.11187
2948 longitude: 22.24048
2949 rmsGeoModelResolutionCode: 1
2950 CharacteristicsBasic:
2951 value:
2952 construction: "ATC1"
2953 occupancy: "ATC1"
2954 yearBuilt: 1973
2955 numOfStories: 3
2956 CharacteristicsEuBasic:
2957 value:
2958 construction: "ATC0"
2959 occupancy: "RMS1"
2960 yearBuilt: 1990
2961 numOfStories: 0
2962 CharacteristicsFlood:
2963 value:
2964 construction: "ATC16"
2965 occupancy: "ATC37"
2966 yearBuilt: 1964
2967 numOfStories: 1
2968 firstFloorHeightAboveGround: 1
2969 basement: "YES"
2970 foundationType: 0
2971 CoverageValuesFlood:
2972 value:
2973 buildingValue: 1093488.618
2974 contentsValue: 966388.5339
2975 businessInterruptionValue: 44393.0543
2976 responses:
2977 400Response:
2978 description: The request was unacceptable, likely due to missing a required input.
2979 content:
2980 application/json:
2981 schema:
2982 $ref: '#/components/schemas/ErrorOutput'
2983 401Response:
2984 description: No valid API key provided.
2985 content:
2986 application/json:
2987 schema:
2988 $ref: '#/components/schemas/ErrorOutput'
2989 500Response:
2990 description: Something went wrong on our end (this happens rarely)
2991 content:
2992 application/json:
2993 schema:
2994 $ref: '#/components/schemas/ErrorOutput'
2995security:
2996 - apiKey: []