-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschema.graphql
7607 lines (5895 loc) · 210 KB
/
schema.graphql
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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
The @defer directive may be specified on a fragment spread to imply de-prioritization, that causes the fragment to be omitted in the initial response, and delivered as a subsequent response afterward. A query with @defer directive will cause the request to potentially return multiple responses, where non-deferred data is delivered in the initial response and data deferred delivered in a subsequent response. @include and @skip take precedence over @defer.
"""
directive @defer(if: Boolean = true, label: String) on FRAGMENT_SPREAD | INLINE_FRAGMENT
directive @fsApplyExclusion on FIELD_DEFINITION
directive @fsHasPolicy(service: Service!) on FIELD_DEFINITION | ARGUMENT_DEFINITION
directive @fsRecordAPIUsage(service: APIUsageService!) on INPUT_FIELD_DEFINITION | FIELD_DEFINITION
directive @fsValidation(constraint: String!) on INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
directive @goField(forceResolver: Boolean, name: String) on INPUT_FIELD_DEFINITION | FIELD_DEFINITION
enum APIUsageService {
LOCATION
FLOOD
FIRE
HEAT
WIND
AIR
DROUGHT
HAIL
}
"""The AVM Provider provides metadata for an AVM provider."""
type AVMProvider {
"""The canonical provider ID that provides the AVM"""
id: Int64!
"""Provides the name of the AVM provider."""
name: String
"""A URL representation of the providers company logo."""
logo: String
}
"""
Air Quality Color category. Color reflects severity of pollution, on a scale 1-6, with 6 being most severe.
"""
type AirColor {
"""Color id."""
colorId: Int!
"""Description of color meaning."""
description: String!
"""
Category color. The color makes it easy for people to quickly determine whether air quality is reaching unhealthy levels in their communities.
"""
color: String!
"""
PM 2.5 measurement range corresponding to color. Contains an array with two values, the lower and upper bounds of the range.
"""
pm25Range: [Float]!
"""
Ozone measurement range corresponding to color. Contains an array with two values, the lower and upper bounds of the range.
"""
ozoneRange: [Int64]!
}
"""Filter to narrow the values by year, relative year, or threshold."""
input AirDayFilter {
relativeYears: [Int64!]
}
"""Historical air quality index for the property."""
type AirHistoricAQI {
"""The historic year."""
year: Int64!
"""Average AQI of the year."""
aqiAvg: Int64
"""Worst AQI of the year."""
aqiMax: Int64
"""Date of the worst AQI of the year."""
worstDate: Date
"""Criteria pollutant"""
criteriaPollutant: CriteriaPollutant!
}
"""Filter to narrow air historic days."""
input AirHistoricDayFilter {
colorID: Int64!
}
"""Historical air quality days by pollutants for the property."""
type AirHistoricQualityDay {
"""The historic year"""
year: Int64!
"""Number of ozone days. Null means no data."""
ozoneDays: Int64
"""Number of human-caused PM 2.5 days. Null means no data."""
smokeDays: Int64
"""Number of ahthropogenic days. Null means no data."""
anthroDays: Int64
"""Total number of days with pollution. Null means no data."""
totalDays: Int64
}
interface AirPerilSummary {
airFactor: Int64
}
"""Number of poor air quality days in a year by severity."""
type AirQualityDay {
"""Socio-economic pathway of the prediction model."""
ssp: SSP!
"""Year asscociated with the point."""
year: Int64!
"""Relative year to this year. Can be negative."""
relativeYear: Int64!
"""Air Quality Color, based on severity of pollution."""
color: AirColor!
"""Number of ozone-polluted days."""
ozoneDays: Int64!
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on ozoneDays.
"""
ozoneDaysYAxisHeight: Int
"""Number of human-caused PM 2.5 days."""
anthroPM25Days: Int64!
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on anthroPM25Days.
"""
anthroPM25DaysYAxisHeight: Int
"""Maximum number of days with smoke."""
smokeMaxDays: Int64!
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on smokeMaxDays.
"""
smokeMaxDaysYAxisHeight: Int
"""Average number of days with smoke."""
smokeAvgDays: Int64!
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on smokeAvgDays.
"""
smokeAvgDaysYAxisHeight: Int
"""Total number of days from all pollutants."""
totalDays: Int64!
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on totalDays.
"""
totalDaysYAxisHeight: Int
}
"""Query to obtain air-related data."""
type AirQuery {
"""Air Quality Index category."""
color: [AirColor]
"""Map legend lookup."""
mapLegend: MapLegend!
"""Current Air Model version."""
version: VersionRelease!
}
"""The bounding box GeoJSON (Polygon)"""
type Bbox {
"""GeoJSON geometry type Polygon."""
type: String
"""
Coordinates of the Polygon.
Example: *[[[-76.963460575,39.400443189],[-76.963460575,39.400823574],[-76.962570569,39.400823574],[-76.962570569,39.400443189],[-76.963460575,39.400443189]]]*
"""
coordinates: [[[Float!]]]
}
"""Building characteristic for a Property"""
type Building implements Location & Excluding {
"""
First Street ID (FSID) is a unique identifier assigned to each location.
Example: 392804911
"""
fsid: Int64!
"""Building identifier within property"""
buildingId: Int!
"""Property on which the building is located"""
property: Property!
"""
Whether or not the property has a basement.
Example: true
"""
hasBasement: Boolean
"""
Number of units in Property
Example: 1
"""
units: Int64
"""
Number of stories for the Property
Example: 2
"""
stories: Int64
"""Construction characteristics"""
construction: BuildingConstruction
"""Roof characteristics"""
roof: BuildingRoof
"""Year built"""
yearBuilt: Int64
"""Floor size in square feet"""
sqft: Int64
"""Replacement cost per square foot"""
replacementCostPerSqft: Int64
"""
The direction of the largest face of the building. Format as direction (N, NE, E, SE, S, SW, W, NW)
"""
buildingOrientation: CompassDirection
"""
The design standard to which the building is built, displayed as text (low, middle, high)
"""
windDesignStandard: BuildingWindDesignStandard
"""The air filter type used in the building"""
airFilterId: Int
source: BuildingSource
"""First Street's link to the building on FirstStreet's website."""
riskfactorLink: String
"""
The height in centimeters associated with the floor elevation for the building.
Example: 23
"""
floorElevation: Int64
"""The landuse code id of this building."""
landuseCodeId: Int64
"""The foundation type id of this building."""
foundationTypeId: String
"""The foundation type of this building."""
foundationType: String
"""
Indicates if the building is used for residential purposes.
Example: true
"""
isResidential: Boolean
"""If property is excluded, the reason for exclusion."""
exclusion: Exclusion
"""Flood details for the building."""
flood: BuildingFlood
"""Fire details for the building."""
fire: BuildingFire
"""Wind details for the building."""
wind: BuildingWind
"""Heat details for the building."""
heat: BuildingHeat
"""Air details for the building."""
air: BuildingAir
"""
A collection of nodes that represents geographical information for the building.
"""
geometry: LocationGeometry
"""Property Value Implications due to Insurance"""
insuranceImpact: BuildingInsuranceImpact
}
"""AirQuality details for building."""
type BuildingAir implements Excluding & AirPerilSummary {
"""The building's Air Factor."""
airFactor: Int64
"""
Text representation of the Air Factor. Possible values are: minimal, minor, moderate, major, severe, extreme.
"""
factorScale: FactorScale
"""
The sign of future air quality probability minus current air quality probability (-1 is decreasing, 0 is unchanging, 1 is increasing)
"""
riskDirection: Int64
"""Risk Factor link to AirQuality Report for the property."""
link: String!
"""Details for property air damages."""
consequences(input: BuildingAirConsequencesInput): BuildingAirConsequences
"""Internal. Get key insight items for the building."""
insights: [KeyInsight]
"""If property is excluded, the reason for exclusion."""
exclusion: Exclusion
}
"""Estimated poor indoow air quality data."""
type BuildingAirConsequences {
"""Indoor air quality index estimate."""
indoorAQI: [BuildingAirConsequencesAQI!]
}
"""
Indoor air quality index estimate based on outdoor air quality and building parameters.
"""
type BuildingAirConsequencesAQI {
"""Air quality color category."""
color: AirColor
"""Lower estimate for indoor Air Quality Index(AQI)"""
aqiLower: Int
"""Upper estimate for indoor Air Quality Index(AQI)"""
aqiUpper: Int
}
"""Building parameters to use when calculating air consequences."""
input BuildingAirConsequencesInput {
"""
The general land use code
Example: 1 (residential)
"""
landuseCodeId: Int
"""Year when the property has been built."""
yearBuilt: Int
"""Floor area in square feet."""
buildingSqft: Int
"""Number of units in property."""
units: Int
"""Number of stories for the property."""
stories: Int
"""The type of air filter."""
airFilterId: Int
"""Does the structure have an air purifier?"""
hasAirPurifier: Boolean
"""Have sealing/insulation upgrades been made?"""
hasEnergyStarInsulation: Boolean
}
type BuildingConnection {
"""Returns a list type that wraps edge type."""
edges: [BuildingEdge!]!
"""Pagination information in relation to current page."""
pageInfo: PageInfo!
"""
Total number of records for the connection.
Example: *15382*
"""
totalCount: Int64
}
type BuildingConstruction implements BuildingMaterial {
"""Material used for exterior walls of the structure"""
material: String
combustibility: CombustibilityRating
}
type BuildingCooling {
"""Year asscociated with the point."""
year: Int64!
"""Relative year to this year. Can be negative"""
relativeYear: Int64!
"""Dollar values in US Dollars, can be 0."""
cost: Int64
"""
The amount of electricity used for the purpose of maintaining a comfortable indoor temperature, in kwH
"""
energy: Float
"""Electric costs per Kwh."""
costPerKwh: Float
"""
The temperature from which coolingDays and coolingDegreeDays are calculated.
"""
coolingTemp: Float
}
type BuildingEdge {
"""
Cursor is a string that can be used in subsequent request as value of a connection "after" argument, to request page starting after this item.
Example: *Y3Vyc29yOjEyNTI0MA==*
"""
cursor: String
"""Contains one page record data."""
node: Building!
}
input BuildingFilters {
"""Filter buildings by building Ids."""
buildingId: [Int!]
}
type BuildingFire implements FireStatistics & Excluding & FirePerilSummary {
"""The building's Fire Factor"""
fireFactor: Int64
"""
Text representation of the Fire Factor. Possible values are: minimal, minor, moderate, major, severe, extreme.
"""
factorScale: FactorScale
"""Risk Factor link to Fire Report for the property"""
link: String!
"""
Average wildfire risk that would be greater than X% of counties in the United States, according to the US Forest Service. Ranking is based on the property's county.
"""
usfsRelativeRisk: Float
"""
The level of combustibility associated with open space around the building. Adding open, defensible space around a building reduces fire risk.
"""
defensibleSpace: CombustibilityRating
"""
The sign of future burn probability minus current burn probability (-1 is decreasing, 0 is unchanging, 1 is increasing)
"""
riskDirection: Int64
probability: BuildingFireProbability
"""Details for property fire losses."""
consequences(input: BuildingFireConsequencesInput): BuildingFireConsequences!
"""Internal. Get key insight items for the property"""
insights: [KeyInsight]
"""If property is excluded, the reason for exclusion."""
exclusion: Exclusion
}
type BuildingFireConsequences {
damage: BuildingFireConsequencesDamage
burn: BuildingFireConsequencesBurn!
rebuild: BuildingFireConsequencesRebuild!
cumulative: [BuildingFireConsequencesCumulative!]
}
"""Estimates assuming that a fire reaches this building"""
type BuildingFireConsequencesBurn {
"""
Days to repair (or rebuild) a building given flame lengths of
0 - 2 feet, 2-4 feet, 4-8 feet, 8 - 12 feet, 12-20 feet, 20 feet+
"""
daysToRepairBin: [Float!]
}
"""
Cumulative likelihood of complete destruction if wildfire occurs over timeframe (%)
"""
type BuildingFireConsequencesCumulative {
"""Year associated with the point."""
year: Int64!
"""Year, as relative to the current year"""
relativeYear: Int64!
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on combined (greater of burn or ember) wildfire risk.
"""
yAxisHeight: Int
"""
The data point based on combined (greater of burn or ember) wildfire risk.
"""
point: Float
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on ember risk.
"""
emberYAxisHeight: Int
"""The data point based on ember risk."""
emberPoint: Float
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on burn(flame) risk.
"""
flameYAxisHeight: Int
"""The data point based on burn(flame) risk."""
flamePoint: Float
}
type BuildingFireConsequencesDamage {
conditional: [BuildingFireConsequencesDamageConditional!]
}
"""Annual likelihood of wildfire risks"""
type BuildingFireConsequencesDamageConditional {
"""Year associated with this data point."""
year: Int64!
"""Year, as relative to the current year"""
relativeYear: Int64!
"""Socio-economic pathway of the prediction model."""
ssp: SSP!
"""
Percentage chance of destruction due to wildfire flames, assuming that a fire reaches this building (out of 1)
"""
flameLossConditional: Float
"""
Time lost to repair or rebuild due to wildfire flames, assuming that a fire reaches this building (in days)
"""
flameTimeConditional: Float
"""
Percentage chance of destruction due to wildfire embers, assuming that embers reach this building (out of 1)
"""
emberLossConditional: Float
"""
Time lost to repair or rebuild due to wildfire embers, assuming that embers reach this building (in days)
"""
emberTimeConditional: Float
"""Average annual loss due to wildfire flames (in dollars)"""
flameLoss: Float
"""Probability of building destruction by wildfire flames"""
flamePercent: Float
"""Average annual time loss to repairs/rebuilding due to flames (in days)"""
flameTime: Float
"""Average annual loss due to wildfire embers (in dollars)"""
emberLoss: Float
"""Probability of building destruction by wildfire embers (out of 1)"""
emberPercent: Float
"""Average annual time loss to repairs/rebuilding due to embers (in days)"""
emberTime: Float
"""Relative level of risk of wildfire embers falling on this building"""
emberRiskRating: EmberRiskRating @deprecated(reason: "Ember risk percentage is now available from emberPercent field")
}
input BuildingFireConsequencesInput {
"""
The general land use code
Example: 1 (residential)
"""
landuseCodeId: Int
"""The presence of defensible space around this building."""
defensibleSpace: Boolean
"""The type of roofing material."""
roofCoverId: String
"""The roof cover's combustibility id."""
roofCoverCombustibililtyId: Int
"""The predominant construction material of the building"""
constructionId: String
"""The construction's combustibility id."""
constructionCombustibilityId: Int
"""Number of stories for the building"""
stories: Int
"""Floor size in square feet"""
buildingSqft: Int
"""
Whether or not the building abides by the Fireproofing building code
True => has fire-proofing
"""
fireCode: Boolean
"""Replacement cost of the building in dollars."""
pricePerSqft: Int64
}
"""Replacement cost to rebuild this building"""
type BuildingFireConsequencesRebuild {
"""Replacement cost to rebuild this building"""
cost: Int64
"""Not Implemented. Replacement time to rebuild this building."""
days: Int64
}
"""Fire probability details for building."""
type BuildingFireProbability {
burn: [BuildingFireProbabilityBurn]
cumulative: [BuildingFireProbabilityCumulative]
damage: BuildingFireProbabilityDamage
}
"""Fire probability details for building"""
type BuildingFireProbabilityBurn {
"""Socio-economic pathway of the prediction model."""
ssp: SSP!
year: Int64!
"""Year relative to 2023."""
relativeYear: Int64!
"""
The percent chance of burn for the given year based on combined wildfire risk (greater of burn and ember).
"""
percent: Float
"""The percent chance of burn for the given year based on ember risk."""
emberPercent: Float
"""
The percent chance of burn for the given year based on burn(flame) risk.
"""
flamePercent: Float
"""Max height of flame length"""
flameMax: Float!
"""Mean height of flame length"""
flameMean: Float!
"""
Distribution of expected flame heights, represented in feet
0 - 2 feet, 2-4 feet, 4-8 feet, 8 - 12 feet, 12-20 feet, 20 feet+
"""
flameBin: [Float!]
"""
A boolean flag that determines if the property is in an area that would experience embers from a nearby wildfire
"""
emberZone: Boolean!
}
"""
The wildfire risk likelihood (% probability) to the building footprint by cumulative year based on combined wildfire risk (greater of burn and ember).
"""
type BuildingFireProbabilityCumulative {
"""Year asscociated with the point."""
year: Int64!
"""Year increments in relation to this year."""
relativeYear: Int64!
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on combined (greater of burn or ember) wildfire risk.
"""
yAxisHeight: Int
"""
The data point based on combined (greater of burn or ember) wildfire risk.
"""
point: Float
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on ember risk.
"""
emberYAxisHeight: Int
"""The data point based on ember risk."""
emberPoint: Float
"""
The max height of the y axis when the data point is being represented on a graph (from 0-100, where 100 is the max value) based on burn(flame) risk.
"""
flameYAxisHeight: Int
"""The data point based on burn(flame) risk."""
flamePoint: Float
}
"""Building fire damage probability damage."""
type BuildingFireProbabilityDamage {
conditional: [BuildingFireProbabilityDamageConditional]
}
"""
The likelihood a structure ignites if it is within a fire. This field is beta and is subject to change.
"""
type BuildingFireProbabilityDamageConditional {
year: Int64!
relativeYear: Int64!
"""Socio-economic pathway of the prediction model."""
ssp: SSP!
"""
Chance of structural destruction assuming a wildfire reaches this building (out of 1)
"""
flameLossConditional: Float
"""
Downtime at this building, assuming that wildfire flames reach this building
"""
flameTimeConditional: Float
"""Annualized chance this structure is destroyed by wildfire flames"""
flameLoss: Float
"""Annualized downtime due to wildfire flames"""
flameTime: Float
"""
Annualized chance this structure is destroyed by wildfire embers (out of 1)
"""
emberLoss: Float
"""Annualized downtime due to wildfire embers"""
emberTime: Float
}
"""Flood details for building."""
type BuildingFlood implements FloodStatistic & Excluding & FloodPerilSummary {
"""
The building's Flood Factor, a numeric integer from 1-10 (where 1 = minimal and 10 = extreme) based on flooding risk to the building footprint.
Flood risk is defined as a combination of cumulative risk over 30 years and flood depth.
Flood depth is calculated at the lowest elevation of the building footprint (largest if more than 1 exists, or building centroid where footprint does not exist).
"""
floodFactor: Int64
"""
Text representation of the Flood Factor. Possible values are: minimal, minor, moderate, major, severe, extreme.
"""
factorScale: FactorScale
"""Risk Factor link to Flood Report for the property"""
link: String!
"""
The location's risk direction represented in a numeric value based on the change in risk for the location from 2020 to 2050 for the climate model realization of the RCP 4.5 mid emissions scenario.
-1 = decreasing
0 = stationary
1 = increasing
"""
riskDirection: Int64
"""
Denotes what environmental risks impact the location represented in a numeric value.
1 = precipitation
2 = precipitation and sea level rise
3 = precipitation, sea level rise and hurricane storm surge
Coastal areas on the East Coast and Hawaii will return 3, other coastal areas will return 2 and all other locations will return 1.
"""
environmentalRisk: Int64
"""
The predominant form of flooding for the building: inland fluvial, inland pluvial, coastal, or none.
For inland areas, flooding depths are provided as the maximum of pluvial and fluvial models. In coastal areas, a coupled model merges the three flooding sources into a single coastal data set.
Example: inland pluvial
"""
floodType: String
"""Flood probabilty details for building."""
probability: BuildingFloodProbability
"""Details for building flood losses."""
consequences(input: BuildingFloodConsequencesInput): BuildingFloodConsequences
"""
The list of modeled historic events that inundated the location.
Inundation is defined as having flood depth >0 for property queries or >1 property with >0 flood depth for higher-level locations.
Flood depth is calculated at the lowest elevation of the building footprint (largest if more than 1 exists, or property centroid where footprint does not exist).
"""
historic: [BuildingFloodHistoric]
"""Internal. Get key insight items for the building"""
insights: [KeyInsight]
"""If building flood data is excluded, the reason for exclusion."""
exclusion: Exclusion
}
"""Details for building flood losses."""
type BuildingFloodConsequences {
byDepth: [BuildingFloodConsequencesByDepth]
byProbability: [BuildingFloodConsequencesByProbability]
annualized: [BuildingFloodConsequencesAnnualized!]
}
"""Expected losses over time"""
type BuildingFloodConsequencesAnnualized implements OverTime {
"""Year associated with this data point."""
year: Int64!
"""Year, as relative to the current year"""
relativeYear: Int64!
"""Socio-economic pathway of the prediction model."""
ssp: SSP!
"""
Percentile value for estimates, one of: 10, 50, 90. 10th percentile estimate is low value, 90th percentile is high value, and 50th is mean.
"""
percentile: Int
"""Estimated damages in US dollars"""
damages: Int64
"""Estimated loss of building use in days"""
days: Int64
}
"""Expected losses for specified depth."""
type BuildingFloodConsequencesByDepth {
"""
Depth values for calculating consequences, in cm. By default one of: 3, 15, 31. Can be adjusted through BuildingFloodConsequencesInput parameter.
"""
depth: Int64!
"""
Percentile value for estimates, one of: 10, 50, 90. 10th percentile estimate is low value, 90th percentile is high value, and 50th is mean.
"""
percentile: Int!
"""
Provides the loss in US dollars due to flood risk for the building by depth.
"""
damages: Int64
"""Provides the loss in days due to flood risk for the building by depth."""
days: Int64
}
"""Annual depths and damages by return period"""
type BuildingFloodConsequencesByProbability {
"""Year associated with this data point."""
year: Int64!
"""Year, as relative to the current year"""
relativeYear: Int64!
"""Socio-economic pathway of the prediction model."""
ssp: SSP!
"""Return period of flooding"""
returnPeriod: Int64!
"""
Percentile value for estimates, one of: 10, 50, 90. 10th percentile estimate is low value, 90th percentile is high value, and 50th is mean.
"""
percentile: Int!
"""Estimated depth of flooding"""
depth: Int64
"""Estimated damages in US dollars"""
damages: Int64
"""Estimated loss of building use in days"""
days: Int64
}
input BuildingFloodConsequencesInput {
"""
The general land use code
Example: 1 (residential)
"""
landuseCodeId: Int
"""The predominant construction material of the building"""
constructionId: String
"""Number of stories for the Property"""
stories: Int
"""Floor size in square feet"""
buildingSqft: Int
"""Whether or not the property has a basement."""
basement: Boolean
"""Number of units in Property"""
units: Int
"""
The height in centimeters associated with the floor elevation for the building.
"""
foundationHeight: Int
"""
The depth in cm of the flood event that the damage should be calculated for. Multiple values accepted, delineated with a comma.
Maximum number of depths: 35, each depth is a whole number (non-negative integer) under 1000.
Example: *30, 45*
Default: *3,15,31*
"""
depths: [Int64!]
"""Replacement cost of the building in dollars."""
pricePerSqft: Int64
"""
Flag to indicate timber construction. Overriden by constructionId if provided.
"""
isTimber: Boolean
}
"""
The information associated with the event(s) for event(s) where the area of the model simulation of the historic event overlaps any area of the location.
This includes event ID (unique First Street ID assigned to all modeled historic events), type, name and flood impact to the location.
Impact includes the depth of flooding (in centimeters) to the building footprint for building searches.
"""
type BuildingFloodHistoric implements FloodHistoricEvent {
"""
A unique First Street identifier assigned to each modeled historic event.
"""
eventId: Int64!
"""
The name of the modeled historic event if it exists (note: several were strong pluvial events).
"""
name: String!
"""
Categorization of event type (hurricane, fluvial, nor'easter, or tropical storm).
"""
type: String!
"""The year when the event occured."""
year: Int64!
"""The month when the event occured."""
month: Int64!
"""
The estimated recurrence interval of the event, or the inverse of the annual likelihood. For example a 1 in 500 annual likelihood event.
"""
returnPeriod: Int64
"""
The total count of parcels that had any flooding (>0) to the building footprint that are within the mapped area of the historic event's geometry.
"""
affectedProperties: Int64!
"""