standalone.loads

---

The standalone.loads namespace provides functions to manage sessions for wind speed, wind design and snow calculations.

---

standalone.loads.start

At the beginning of every API session, the session must be started. This function must be the first function in the array. This initiates a session and will return a session_id which can be used in subsequent calls made in the following 30 minutes to skip the verification process, thereby dramatically reducing the time to response.

important

The start function must always be the first function even if session_id is provided.

Key	Type	Accepts	Description	Default
keep_open	boolean	true, false	If the session should be kept on standby. If true, subsequent calls to the API using the session_id provided from the first call in lieu of key, will be 4-8x faster.	false

Sample input for standalone.loads.start

{

"function": "standalone.loads.start",

"arguments": { "keep_open": false }

}

After authenticating using the API key, the response object will contain some useful information. The session_id key can be used to make further calls to the same session, skipping authentication if keep_open was set to true. The session_expiry_time provides an approximate Unix time until the session expires. After this, the user must re-authenticate using their API key.

tip

The returned session_id can be provided in the auth object of subsequent calls to make the request faster.

---

standalone.loads.getCountryDesignCodes

To get the supported design codes with the corresponding countries for each load calculation:

Sample input for standalone.loads.getCountryDesignCodes

{

"function": "standalone.loads.getCountryDesignCodes",

"arguments": {}

}

Sample response for standalone.loads.getCountryDesignCodes

{

"country_design_code": {

"United States": {

"wind": [

"ASCE 7-10",

"ASCE 7-16",

"ASCE 7-22"

],

"snow": [

"ASCE 7-10",

"ASCE 7-16"

],

"seismic": [

"ASCE 7-16"

]

}

},

"API_design_codes": {

"United States": {

"wind": [

"asce7-10",

"asce7-16",

"asce7-22"

],

"snow": [

"asce7-10",

"asce7-16"

],

"seismic": [

"asce7-16"

]

}

}

}

Some data output were removed for brevity.

---

standalone.loads.getSiteData

Using this function, you can get the available site data for specified location with the corresponding design code using minimal input.

Sample input for standalone.loads.getSiteData

{

"function": "standalone.loads.getSiteData",

"arguments": {

"site_data": {

"design_code": "nscp2015",

"project_address": "San Marcelino, Zambales, Philippines",

"occupancy_category": "III"

},

"api_version": 2

}

}

Relevant components

• The site_data object
• (Optional) api_version int

The response will return the site details, site wind speed, site snow load, and site seismic data, whichever is available.

Sample response for standalone.loads.getSiteData for NSCP 2015 location

{

"site_data": {

"country": "Philippines",

"lat": 15.026051,

"lng": 120.2743484,

"elevation": 185.55,

"formatted_address": "San Marcelino, Zambales, Philippines",

"address_components": [],

"address": "San Marcelino, Zambales, Philippines"

},

"wind_data": {

"all_wind_speed": {

"I": 262,

"II": 262,

"III": 260,

"IV": 250,

"V": 250

},

"wind_speed_unit": "kph",

"wind_speed": 260

},

"snow_data": {

"snow_load": ""

},

"topography": {},

"seismic_data": {

"Z": 0.4,

"seismic_zone": 4,

"reference": "Philippine Institute of Volcanology and Seismology (DOST-PHIVOLCS, 2021)",

"D": 18.923400072718362,

"nearest_fault": "Iba Fault",

"Na": 1,

"Nv": 1,

"distance_unit": "km"

}

}

Some data output were removed for brevity.

Parameters

The following Objects are required parameters for the above functions.

---

site_data

Refer to definition in standalone.loads.getLoads

Common properties for all design codes

Key	Type	Description
design_code	string	Which design code is this based on: as1170, asce7-10, asce7-16, asce7-22, en1991, nbcc2015, nbcc2020, is875, nscp2015, cfe-viento, asce7-22
project_address	string	The site location. This will use Google Maps to search the address and select the first option.
lat	float	Latitude of site location (used instead of project_address). E.g. 41.878100 for Chicago
lng	float	Longitude of site location (used instead of project_address). E.g. -87.629800 for Chicago

Design code specific properties

Key	Type	Design Code	Description/Options
risk_category	string	ASCE 7	I, II, III, IV
occupancy_category	string	NSCP 2015	I, II, III, IV, V
sls_and_uls	object	AS/NZS 1170	object containing country, design_working_life, importance_level
sls_and_uls.country	string	AS/NZS 1170	australia or new_zealand Required for SLS and ULS wind speeds
sls_and_uls.design_working_life	string	AS/NZS 1170	construction_equipment, 5_years, 25_years, 50_years, 100_years, less_than_6_months (NZ only) Required for SLS and ULS wind speeds
sls_and_uls.importance_level	string	AS/NZS 1170	Number between 1, 5 specifying importance level Required for SLS and ULS wind speeds
site_class	string	ASCE 7-16	A, B, C, D, D-default, E
site_class	string	ASCE 7-22	A, B, BC, C, CD, D, DE, E
site_class	string	NBCC 2020	A, B, C, D, E

---

standalone.loads.getLoads

Using the below variables, users can get the wind speed, snow loads and wind pressures from ASCE 7, AS/NZS 1170, NBCC, Eurocode Design Standards, IS 875, NSCP 2015, and Comisón Federal de Electricidad (CFE Viento).

Sample input for standalone.loads.getLoads

{

"function": "standalone.loads.getLoads",

"arguments": {

"project_details": {

"name": "Pat's House",

"id": "SKYPH-001",

"company": "SkyCiv",

"designer": "Patrick",

"client": "",

"notes": "",

"units": "imperial" //imperial or metric

},

"site_data": {},

"building_data": {}

}

}

Try standalone.loads.getLoads

Relevant components

• The site_data object
• The building_data object
• (Optional) project_details object
• (Optional) site_analysis object
• (Optional) api_version int

The response will return design wind speed, elevations, topography, wind and snow pressures and confirm the address of the site location under the key wind_speed. In addition to this, if the terrain data is requested (user provides wind_direction and exposure keys) it will also return topography data:

Sample response for standalone.loads.getLoads

{

"site_data": {

"country": "United Kingdom",

"lat": 51.501364,

"lng": -0.14189,

"elevation": 6.36,

"formatted_address": "Westminster, London SW1A 1AA, UK"

},

"wind_data": {

"uk_ireland_contour": 21.621648873984707,

"distance_from_shore": {

"0": {

"distance": 233.92573712464545,

"lat": 53.60510578995467,

"lng": -0.1418899999999966

},

"30": {

"distance": 174.5852678317777,

"lat": 52.98168910830151,

"lng": 0.7127760997660391

}

// etc

},

"wind_speed": 21.8

},

"snow_data": {

"snow_region": "zone3",

"snow_load": 0.5

},

"topography": {

"code": "en1991",

"topo_factor": 1,

"comments": "",

"location_of_peak": 1740,

"elevation_of_peak": 26.6097240447998,

"location_of_foot": -1580,

"elevation_of_foot": 0,

"elevation_of_midheight": 13.3048620223999,

"slope": 0.008014977121927652,

"H": 26.6097240447998,

"x": -1740,

"Lu": 3320,

"Ld": 240,

"terrain_type": "Flat",

"elevation_image_base64": "**Base 64 Data**"

},

"snow_pressure": null,

"wind_pressure": {

"pressure_type": "building",

"pressure_unit": "Pa",

"elevation_or_location_unit": "m",

"pressures": [

{

"dirn": "along_L",

"surface": "windward_wall",

"elevation": [3, 6, 9],

"pos_Cpi": [204.49, 204.49, 204.49],

"neg_Cpi": [425.75, 425.75, 425.75]

},

{

"dirn": "along_L",

"surface": "leeward_wall",

"elevation": 21,

"pos_Cpi": -325.11,

"neg_Cpi": -103.85

},

{

"dirn": "along_L",

"surface": "sidewall",

"location": [2, 10, 12.4],

"pos_Cpi": [-619.531865399467, -442.5227609996193, -309.7659326997335],

"neg_Cpi": [-398.27048489965733, -221.26138049980966, -88.50455219992386]

},

{

"surface": "roof",

"zone": "F",

"pos_Cpi": 194.71,

"neg_Cpi": -592.98

},

{

"surface": "roof",

"zone": "G",

"pos_Cpi": 194.71,

"neg_Cpi": -495.63

},

// etc

],

"forces": null

}

}

Here is a sample of the elevation image that is returned when elevation_img: true :

---

Parameters

The following Objects are required parameters for the above functions.

---

site_data

Get wind speed from site location, based on ASCE 7-10, ASCE 7-16, ASCE 7-22 (wind and seismic data), AS/NZS 1170, NBCC 2015, NBCC 2020, EN 1991, IS 875, NSCP 2015, Comisón Federal de Electricidad (CFE Viento), and Documento Básico (CTE DB SE-AE).

Common properties for all design codes

Key	Type	Description
design_code	string	Which design code is this based on: as1170, asce7-10, asce7-16, asce7-22, en1991, nbcc2015, nbcc2020, is875, nscp2015, cfe-viento, asce7-22, cte-db-se
project_address	string	The site location. This will use Google Maps to search the address and select the first option.
wind_direction	string	Wind direction (going to). N, NE, E, SE, S, SW, W, NW.
lat	float	Latitude of site location (used instead of project_address). E.g. 41.878100 for Chicago
lng	float	Longitude of site location (used instead of project_address). E.g. -87.629800 for Chicago

Design code specific properties

Key	Type	Design Code	Description/Options
risk_category	string	ASCE 7	I, II, III, IV
exposure	string	ASCE 7/NSCP 2015	Required for topography result B, C, D
ari	integer	AS/NZS 1170	Annual Recurrence Interval (in years) 1, 5, 10, 20, 25, 50, 100, 200, 250, 500, 1000, 2000, 2500, 5000, 10000
sls_and_uls	boolean or object	AS/NZS 1170	object containing country, design_working_life, importance_level Set tofalse - if ari is used
sls_and_uls.country	string	AS/NZS 1170	australia or new_zealand Required for SLS and ULS wind speeds
sls_and_uls.design_working_life	string	AS/NZS 1170	construction_equipment, 5_years, 25_years, 50_years, 100_years, less_than_6_months (NZ only) Required for SLS and ULS wind speeds
sls_and_uls.importance_level	string	AS/NZS 1170	Number between 1, 5 specifying importance level Required for SLS and ULS wind speeds
wind_region	string	AS/NZS 1170	For user-defined wind region (Optional) A0, A1, A2, A3, A4, A5, B1, B2, C, D, NZ1, NZ2, NZ3, NZ4
recurrence_interval or ari	string	NBCC 2015/NBCC 2020	Annual Recurrence Interval: 10_years, 50_years
importance_level	string	NBCC 2015/NBCC 2020	low, normal, high, post_disaster
limit_state	string	NBCC 2015/NBCC 2020	SLS, ULS
importance_category	string	IS 875	I, II, III, IV
structure_class_is875	string	IS 875	I, II, III, IV
occupancy_category	string	NSCP 2015	I, II, III, IV, V
return_period	string	CFE Viento	10-anos, 50-anos, 200-anos
barometric_pressure	float	CFE Viento	Default value is 760 mm Hg
ambient_temperature	float	CFE Viento	Default value is 25 deg. Celcius

Additonal parameters for user-defined wind speed or ground snow load

Key	Type	Design Code
wind_speed_override	float	ASCE 7, AS/NZS 1170, EN 1991, IS 875, NSCP 2015 Wind Load Calculation
hourly_wind_pressure_override	float	NBCC 2015/NBCC 2020 Wind Load Calculation
snow_load_override	float	ASCE 7, AS/NZS 1170, EN 1991, NBCC 2015/NBCC 2020 Snow Load Calculation
min_roof_snow_load	float	ASCE 7 Snow Load Load Calculation for override on minimum snow load pm value

Additonal site_data parameters for seismic load (ASCE 7-16/ASCE 7-22) - site_data.site_seismic_data

Key	Type	Design Code
site_class	string	ASCE 7-16: A, B, C, D, D-default, E ASCE 7-22: A, B, BC, C, CD, D, DE, E
site_seismic_data	object	User-defined site seismic parameters (optional): sd1, s1, sds, tl
site_seismic_data.tl	float	Long-period transition period
site_seismic_data.sds	float	Design spectral response acceleration parameter at short periods
site_seismic_data.sd1	float	Design spectral response acceleration parameter at 1s period
site_seismic_data.s1	float	Mapped max. considered earthquake spectral response acceleration parameter

Design code specific site_data.topography properties

Key	Type	Design Code	Description/Options
terrain_category	string	AS/NZS 1170	CAT1, CAT2, CAT2.5, CAT3, CAT4
snow_region	string	AS/NZS 1170	For user-defined snow region (optional) For Australia: AN, AC, AS, AT For New Zealand: N1, N2, N3, N4, N5
snow_area_classification	string	AS/NZS 1170	For user-defined snow area classification (optional): alpine, sub-alpine
snow_terrain_class	integer	AS/NZS 1170	1, 2, 3
snow_area_classification	string	NBCC 2015/NBCC 2020	rural, exposed-north-treeline
country	string	EN 1991	Germany, United Kingdom, France... Required for additional parameters (season_month, wind_direction, terrain_category
season_month	string	EN 1991	For Belgium, France, UK, and Ireland For temporary structures: 1 month: January, February, ... 2 months (UK and Ireland only): January-February, March-April, ... 4 months (UK and Ireland only): November-February, December-March, ... 6 months (UK and Ireland only): October-March, April-September, ... For permanent structures: Long-term
wind_direction	string or integer	EN 1991	The angle of which the wind is going to, referenced from N in clockwise direction. Use Any for worst case For Belgium, Poland, United Kingdom, Ireland, and France: (in degrees). Increments of 30° ranging from 0 - 360 For other countries: N, NE, E, SE, S, SW, W, NW
en1991_NF_coz_procedure	integer	EN 1991 (NF)	For France and French territories: The procedure in calculating orography factor: 1, 2
terrain_category	string	EN 1991	For UK and Ireland: 0 for Sea I or II for Country III or IV for Town For France: 0 II IIIa IIIb IV For Netherlands: 0 II III Other countries: I II III IV
distance_inside_town	float	EN 1991	Required for UK and Ireland. Default value is 20
distance_from_shore	float	EN 1991	Required for UK and Ireland. Can be obtained from server if wind direction is not equal to Any. Default value is 100
displacement_height	float	EN 1991	Required for UK and Ireland. Default value is 0
terrain_category	string	IS 875	1, 2, 3, 4
terrain_category	string	CFE Viento	1, 2, 3, 4

ASCE 7-16

Sample site_data input

{

"design_code": "asce7-16",

"project_address": "Wacker Avenue, Chicago",

"country": "United States",

"risk_category": "III",

// lat: 41.878100, or lat: 41°52"41.2"N

// lng: -87.629800, or lng: 87°37"47.3"W

"site_class": "D",

"site_seismic_data": {

"sd1": 0.96,

"s1": 0.54,

"sds": 0.55,

"tl": 8

},

"topography": {

"wind_direction": "N",

"exposure": "B",

"topo_image": true,

}

}

AS/NZS 1170.2

Sample site_data input

{

"design_code": "as1170",

"project_address": "Cabramurra, NSW",

"sls_and_uls": {

"country": "australia",

"design_working_life": "25_years",

"importance_level": "3"

},

"topography": {

"wind_direction": "E",

"terrain_category": "CAT2",

"topo_image": true,

"country": "United States",

"snow_region": "alpine",

"snow_terrain_class": "1"

}

}

NBCC 2015

Sample site_data input

{

"design_code": "nbcc2015",

"project_address": "Toronto",

"ari": "10_years", //50_years

"importance_level": "low", //normal, high, post_disaster

"limit_state": "SLS", // ULS

"topography": {

"wind_direction": "N", //NE etc...

"terrain_category": "A", //B

"topo_image": true,

"country": "Canada",

"snow_area_classification": "rural"

}

}

EN 1991

Sample site_data input

{

"design_code": "en1991",

"project_address": "Buckingham Palace",

"topography": {

"season_month": "January-February",

"wind_direction": "30", //degrees

"topo_image": true,

"country": "United Kingdom",

"season_month": "January-February",

"terrain_category": "I",

"distance_inside_town": 20,

"distance_from_shore": 100,

"displacement_height": 0

}

}

IS 875

Sample site_data input

{

"design_code": "is875",

"project_address": "Delhi",

"importance_category": "I",

"structure_class_is875": "I",

"map_image": false,

"topography": {

"wind_direction": "N",

"terrain_category": "1",

"topo_image": false,

"country": "India"

}

}

NSCP 2015

Sample site_data input

{

"design_code": "nscp2015",

"project_address": "Manila, Metro Manila, Philippines",

"topography": {

"wind_direction": "N",

"topo_image": true,

"country": "Philippines",

"exposure": "B"

},

"occupancy_category": "II"

}

CFE Viento

Sample site_data input

{

"design_code": "cfe-viento",

"project_address": "Monterrey, Nuevo Leon, Mexico",

"return_period": "200-anos",

"barometric_pressure": 760,

"ambient_temperature": 25,

"site_image": true,

"topography": {

"wind_direction": "E",

"terrain_category": "1",

"topo_image": true

}

}

Try standalone.loads.getLoads

---

building_data

Generate wind pressures or snow loads based on building parameters. These parameters have minor differences between design codes. If you need any assistance, please email us at [email protected].

Options for Structure

building_data.structure	Remarks
building	Default value
freestanding_wall	ASCE 7 and AS/NZS 1170 only
truss_tower	ASCE 7 only
rooftop_equipment	ASCE 7-16/ASCE7-22 only
solar_panel	ASCE 7 and AS/NZS 1170 only
signboard	EN 1991 only
pole	EN 1991 only
open_frames	ASCE 7-16/ASCE7-22 only
circular-bin	ASCE 7-16/ASCE7-22 and AS/NZS 1170 only

Options for ASCE 7, AS/NZS 1170, NBCC 2015/NBCC 2020, NSCP 2015

building_data.roof_profile	building_data.wind_parameters.enclosure	building_data.wind_parameters.wind_blockage
gable	enclosed, partially-enclosed, partially-open
monoslope	enclosed, partially-enclosed, partially-open
hip	enclosed, partially-enclosed, partially-open
pitched	open	For ASCE 7/NSCP 2015/CFE Viento: clear, obstructed For AS/NZS 1170: empty, blocked
troughed	open	For ASCE 7/NSCP 2015/CFE Viento: clear, obstructed For AS/NZS 1170: empty, blocked
open-monoslope	open	For ASCE 7/NSCP 2015/CFE Viento: clear, obstructed For AS/NZS 1170: empty, blocked

building_data.wind_parameters.structure_type	Description
mwfrs	Main Wind Force Resisting System
cladding	Components and Cladding

Additonal wind load parameter for user-defined options for ASCE 7-10, ASCE 7-16, and NSCP 2015

Key	Type
building_data.wind_parameters.gust_effect_factor_override	float

Options for IS 875

building_data.roof_profile	building_data.wind_parameters.enclosure
gable	enclosed, medium-opening, large-opening
monoslope	enclosed, medium-opening, large-opening
hip	enclosed, medium-opening, large-opening
pitched	open
open-monoslope	open

Options for AS/NZS 1170, EN 1991, IS 875, and CFE Viento

building_data.wind_parameters.structure_type	building_data.roof_profile
building	gable, monoslope, hip
free_roof	For EN 1991: pitched, open-monoslope For AS/NZS 1170 and CFE Viento: pitched, open-monoslope, troughed
For AS/NZS 1170 and IS 875: cladding	gable, monoslope, hip, pitched, open-monoslope, troughed

User-defined parameter for AS/NZS 1170.2 (2021)

Parameter	Description
building_data.wind_parameters.Mh	User-defined input for Hill-shape multiplier, Mh, for the selected wind source direction and default value for all wind direction (if site_analysis.hillshape_multiplier_all_direction is not defined)
building_data.wind_parameters.Mlee	User-defined input for Lee multiplier, Mlee, for the selected wind source direction and default value for all wind direction (if site_analysis.lee_multiplier_all_direction is not defined)
building_data.wind_parameters.Ms	User-defined input for Shielding multiplier, Ms, for all wind direction
building_data.wind_parameters.Md	User-defined input for Wind Direction multiplier, Md, for the selected wind source direction and default value for all wind direction (if site_analysis.terrain_category_all_directions is not defined)
building_data.wind_parameters.Mc	User-defined input for Climate Change multiplier, Mc, for all wind direction
building_data.wind_parameters.Mz_cat	User-defined input for Terrain Height multiplier, Mz,cat, for all wind direction at height h

building_data.freestandingwall_dimensions for ASCE 7-16 and AS/NZS 1170.2 Freestanding Wall Wind Load Calculation

Parameter	Description
freestandingwall_dimensions.ground_to_top	Structure height from ground to top of wall
freestandingwall_dimensions.wall_width	Wall Width
freestandingwall_dimensions.wall_height	Wall Height
freestandingwall_dimensions.ratio_of_solid_area_to_gross	Solidity ratio of wall
freestandingwall_dimensions.length_of_return_corner	For ASCE 7-16: Length of return corner
wind_parameters.wall_surface_type	For AS/NZS 1170: with-ribs (default), with-corrugations, smooth,
wind_parameters.structure_type	freestandingwall

building_data.open_frames_dimensions for ASCE 7-16/ASCE 7-22 Open Signs/Frames Wind Load Calculation

Parameter	Description
open_frames_dimensions.ground_to_top	Structure height from ground to top of open frames
open_frames_dimensions.ratio_of_solid_area_to_gross	Ratio of solid area to the gross area
open_frames_dimensions.structural_members	Array of member data object: member_id, section_type, section_depth, orientation, member_elevation_bottom, member_elevation_top Refer to Load Gen UI for options
wind_parameters.structure_type	open-frames

building_data.circular_bin_dimensions for ASCE 7-16/ASCE 7-22 Tanks/Silos/Circular Bin Wind Load Calculation

Parameter	Description
circular_bin_dimensions.D	For ASCE 7: Diameter of Circular Bin/Structure
circular_bin_dimensions.H	For ASCE 7: Solid Cylinder Height
circular_bin_dimensions.C	For ASCE 7: Clearance Height above ground
circular_bin_dimensions.Z	For ASCE 7: Ground to Centroid of Structure
circular_bin_dimensions.b	For AS/NZS 1170: Diameter of Circular Bin/Structure
circular_bin_dimensions.c	For AS/NZS 1170: Solid Cylinder Height
circular_bin_dimensions.Z	For AS/NZS 1170: Clearance Height above ground
circular_bin_dimensions.roof_pitch_angle	Roof Pitch Angle
circular_bin_dimensions.configuration	Configuration: isolated, grouped (ASCE 7 only)
circular_bin_dimensions.number_of_tanks	(Optional) Number of Tanks: default value is 1.0

building_data.wind_parameters for ASCE 7-16/ASCE 7-22 and AS/NZS 1170 Tanks/Silos/Circular Bin Wind Load Calculation

Parameter	Description
wind_parameters.structure_type	circular-bin
wind_parameters.enclosure	For ASCE 7: Enclosure Classification: enclosed, partially-enclosed, partially-open
wind_parameters.surface_type	For ASCE 7: Surface Type: moderately-smooth, rough, very-rough
wind_parameters.wall_cladding_area	For ASCE 7: Array values of wall component area (for grouped), e.g. [10,20,30]
wind_parameters.roof_cladding_area	Array values of roof component area, e.g. [10,20,30]

building_data.seismic_parameters for ASCE 7-16 Seismic Load Calculation

Parameter	Description
seismic_parameters	Object with parameters required: structure_height, R, structure_system, weights Optional: Ct, x
seismic_parameters.structure_height	Structure height to be used in calculating the approximate fundamental period of the structure
seismic_parameters.R	Response modification factor
seismic_parameters.redundancy_factor	Redundancy factor (default value is 1.0)
seismic_parameters.structure_system	For determining Ct and x Options are: steel-mrf, concrete-mrf, steel-eccentrically-braced, steel-buckling-restrained, others
seismic_parameters.weights	Array of object with the following: level, elevation (in ft - imperial or m - metric), weight (in kips - imperial or kN - metric)
seismic_parameters.Ct	(Optional) User-defined Ct for calculating the approx. fundamental period of the structure
seismic_parameters.x	(Optional) User-defined x for calculating the approx. fundamental period of the structure

building_data.seismic_parameters for NZS 1170.5 Seismic Load Calculation

Parameter	Description
seismic_parameters	Object with parameters required: structure_height, R, structure_system, weights, Ca, Cv
seismic_parameters.return_period	For calculating return period factor
seismic_parameters.site_subsoil_class	Site Subsoil Class Options are: A, B, C, D, D-default, E
seismic_parameters.T1	Largest translational period in the direction being considered
seismic_parameters.Sp	Structural performance factor. Default value is equal to 1.0
seismic_parameters.mu	Structural ductility factor. Default value is equal to 1.0
seismic_parameters.T1_x	(Optional) For 2-direction analysis. Largest translational period in the X-direction
seismic_parameters.Sp_x	(Optional) For 2-direction analysis. Structural performance factor. Default value is equal to 1.0
seismic_parameters.mu_x	(Optional) For 2-direction analysis. Structural ductility factor. Default value is equal to 1.0
seismic_parameters.T1_z	(Optional) For 2-direction analysis. Largest translational period in the Z-direction
seismic_parameters.Sp_z	(Optional) For 2-direction analysis. Structural performance factor. Default value is equal to 1.0
seismic_parameters.mu_z	(Optional) For 2-direction analysis. Structural ductility factor. Default value is equal to 1.0
seismic_parameters.weights	Array of object with the following: level, elevation (in m), weight (in kN)
seismic_parameters.Z	(Optional) User-defined hazard factor, Z
seismic_parameters.Ru	(Optional) User-defined return period factor, Ru, for Ultimate Limit State
seismic_parameters.D	(Optional) User-defined distance from nearest major fault, D, in km.

building_data.seismic_parameters for NSCP 2015 Seismic Load Calculation

Parameter	Description
seismic_parameters	Object with parameters required: return_period, site_subsoil_class, T1, Sp, mu, weights
seismic_parameters.structure_height	Structure height to be used in calculating the approximate fundamental period of the structure
seismic_parameters.R	Response modification factor
seismic_parameters.structure_system	For determining Ct and x Options are: steel-mrf, concrete-mrf, others
seismic_parameters.weights	Array of object with the following: level, elevation (in m), weight (in kN)
seismic_parameters.Ca	(Optional) User-defined Ca for calculating the Seismic Response Coefficient Ca
seismic_parameters.Cv	(Optional) User-defined Cv for calculating the Seismic Response Coefficient Cv

ASCE 7-16

Sample API input for ASCE 7-16 seismic load calculation

{

"project_details": {

"name": "Pat's House",

"id": "SKYPH-003",

"company": "SkyCiv",

"designer": "Patrick",

"client": "",

"notes": "",

"units": "imperial"

},

"site_data": {

"design_code": "asce7-16",

"project_address": "Wacker Avenue, Chicago",

"risk_category": "III",

"site_image": true,

"topography": {

"wind_direction": "N",

"exposure": "B",

"topo_image": true,

"country": "United States"

},

"site_class": "D",

"site_seismic_data": {

"sd1": 0.96,

"s1": 0.54,

"sds": 0.55,

"tl": 8

}

},

"building_data": {

"design_code": "asce7-16",

"structure": "building",

"roof_profile": "hip",

"building_dimensions": {

"length": 23,

"width": 18,

"mean_roof_height": 66,

"roof_angle": 12

},

"wind_parameters": false,

"snow_parameters": false,

"seismic_parameters": {

"structure_height": 21,

"R": 8.5,

"structure_system": "concrete-mrf",

"Ct": 0.016,

"x": 0.75,

"weights": [

{

"level": "2F",

"elevation": "33",

"weight": "1200"

},

{

"level": "Roof",

"elevation": "66",

"weight": "800"

}

]

}

}

}

NZS 1170.5

Sample API input for NZS 1170.5 seismic load calculation

{

"project_details": {

"name": "Pat's House",

"id": "SKYPH-005",

"company": "SkyCiv",

"designer": "Patrick",

"client": "",

"notes": "",

"units": "metric"

},

"site_data": {

"design_code": "as1170",

"project_address": "Tauranga, New Zealand",

"topography": {

"wind_direction": "N",

"topo_image": false,

"country": "New Zealand",

"terrain_category": "CAT2",

"snow_area_classification": "not-applicable"

},

"sls_and_uls": {

"country": "New Zealand",

"design_working_life": "50_years",

"importance_level": 2

},

"site_image": false

},

"building_data": {

"design_code": "as1170",

"structure": "building",

"roof_profile": "gable",

"building_dimensions": {

"length": 15.0,

"width": 40.0,

"height": 7.0,

"roof_angle": 14.931,

"mean_roof_height": 6.0

},

"wind_parameters": false,

"snow_parameters": false,

"seismic_parameters": {

"return_period": 2000,

"site_subsoil_class": "C",

"T1": "0.67",

"Sp": 1,

"mu": 1,

"weights": [

{ "level": "2", "elevation": "7", "weight": "1000" }

]

}

}

}

NSCP 2015

Sample API input for NSCP 2015 seismic load calculation

{

"project_details": {

"name": "",

"id": "",

"company": "",

"designer": "",

"client": "",

"notes": "",

"units": "metric"

},

"site_data": {

"design_code": "nscp2015",

"project_address": "San Marcelino, Zambales, Philippines",

"topography": {

"wind_direction": "N",

"topo_image": true,

"country": "Philippines",

"exposure": "B"

},

"occupancy_category": "IV",

"seismic_source_type": "A",

"soil_profile_type": "Sd",

"site_seismic_data": {

"Z": "0.40",

"Na": "1.000",

"Nv": "1.000",

"D": "18.923"

}

},

"building_data": {

"design_code": "nscp2015",

"structure": "building",

"wind_parameters": false,

"snow_parameters": false,

"roof_profile": "gable",

"building_dimensions": {

"length": 7,

"width": "7",

"roof_angle": "19.2",

"mean_roof_height": "7"

},

"seismic_parameters": {

"structure_height": "7",

"R": "8.5",

"Ca": "0.440",

"Cv": "0.640",

"structure_system": "concrete-mrf",

"T": "0.2976",

"weights": [

{ "level": "2", "elevation": "3.7", "weight": "500" },

{ "level": "3", "elevation": "7", "weight": "370" }

]

}

},

"site_analysis": {},

"api_version": 2

}

---

project_details

Optional data to be included in the detailed report generated:

Parameter	Description
project_details.units	Optional. For ASCE 7-16 only: metric, imperial
project_details.pressure_unit	User-defined setting to convert the calculated pressures to the desired pressure unit (for AS/NZS 1170 wind load calculation)
project_details.name	Optional
project_details.id	Optional
project_details.company	Optional
project_details.designer	Optional
project_details.client	Optional
project_details.notes	Optional

---

site_analysis

Optional data to calculate design wind pressures for all directions and get the worst wind source direction:

Parameter	Description
site_analysis.terrain_category_all_directions	For AS/NZS 1170, ASCE 7, and NSCP 2015 The user-defined terrain/exposure category per wind source direction
site_analysis.topo_factor_all_direction	For AS/NZS 1170, ASCE 7, and NSCP 2015 The user-defined calculated topographic factor per wind source direction at z = 0 m
site_analysis.lee_multiplier_all_direction	For AS/NZS 1170 only The user-defined calculated Mlee factor per wind source direction
site_analysis.hillshape_multiplier_all_direction	For AS/NZS 1170 only The user-defined calculated Mh factor per wind source direction

ASCE 7/NSCP 2015

Sample site_analysis input

{

"site_data": {}, // see sections above

"project_details": {}, // see sections above

"building_data": {}, // see sections above

"site_analysis": {

"terrain_category_all_directions": {

"N": "B",

"NE": "B",

"E": "B",

"SE": "C",

"S": "C",

"SW": "C",

"W": "C",

"NW": "D"

},

"topo_factor_all_direction": {

"N": 1,

"NE": 1,

"E": 1,

"SE": 1,

"S": 1,

"SW": 1,

"W": 1,

"NW": 1

}

}

}

AS/NZS 1170.2

Sample site_analysis input

{

"site_data": {}, // see sections above

"project_details": {}, // see sections above

"building_data": {}, // see sections above

"site_analysis": {

"terrain_category_all_directions": {

"N": "CAT1",

"NE": "CAT1",

"E": "CAT2.5",

"SE": "CAT2.5",

"S": "CAT4",

"SW": "CAT2.5",

"W": "CAT2.5",

"NW": "CAT1"

},

"topo_factor_all_direction": {

"N": 1,

"NE": 1,

"E": 1,

"SE": 1,

"S": 1,

"SW": 1,

"W": 1,

"NW": 1

},

"lee_multiplier_all_direction": {

"N": 1,

"NE": 1,

"E": 1,

"SE": 1,

"S": 1,

"SW": 1,

"W": 1,

"NW": 1

},

"hillshape_multiplier_all_direction": {

"N": 1,

"S": 1,

"E": 1,

"NE": 1,

"NW": 1,

"W": 1,

"SW": 1,

"SE": 1

}

}

}

api_version

Parameter	Description
api_version	(Optional) Default value is 2.1

report

Parameter	Description
report	(Optional) Setting report false will reduce the call time of the api

Use the sample json files above to start with our API. For more info on parameters used for wind or snow load calculation, please refer to our documentation and/or the load generator UI. You can also generate the API files by clicking the "API file" button on the load generator UI.