GET /api/v1/species

GET /api/beta/species

Get all rows that match the values provided for all column-name parameters used. If the value starts with a tilde ('~'), the rest of the value is treated as a regular expression to match and the matching is case insensitive. Otherwise, the column value must match the parameter value exactly.

Params

Param name Description
limit
optional

Sets an upper bound on the number of results to return. Defaults to 200.

Validations:

  • Must match regular expression /^([1-9][0-9]*|all|none)$/.

offset
optional

Set the number of rows to skip before returning matching rows.

Validations:

  • Must match regular expression /[1-9][0-9]*/.

key
optional

The API key to use for authorization.

associations_mode
optional

Set the amount of data to display about associations. Default is “full_info” for the show action and “count” for the index action.

Validations:

  • Must be one of: full_info, ids, count.

id
optional
spcd
optional
genus
optional
species
optional
scientificname
optional
commonname
optional
notes
optional
created_at
optional
updated_at
optional
AcceptedSymbol
optional
SynonymSymbol
optional
Symbol
optional
PLANTS_Floristic_Area
optional
State
optional
Category
optional
Family
optional
FamilySymbol
optional
FamilyCommonName
optional
xOrder
optional
SubClass
optional
Class
optional
SubDivision
optional
Division
optional
SuperDivision
optional
SubKingdom
optional
Kingdom
optional
ITIS_TSN
optional
Duration
optional
GrowthHabit
optional
NativeStatus
optional
NationalWetlandIndicatorStatus
optional
RegionalWetlandIndicatorStatus
optional
ActiveGrowthPeriod
optional
AfterHarvestRegrowthRate
optional
Bloat
optional
C2N_Ratio
optional
CoppicePotential
optional
FallConspicuous
optional
FireResistance
optional
FoliageTexture
optional
GrowthForm
optional
GrowthRate
optional
MaxHeight20Yrs
optional
MatureHeight
optional
KnownAllelopath
optional
LeafRetention
optional
Lifespan
optional
LowGrowingGrass
optional
NitrogenFixation
optional
ResproutAbility
optional
AdaptedCoarseSoils
optional
AdaptedMediumSoils
optional
AdaptedFineSoils
optional
AnaerobicTolerance
optional
CaCO3Tolerance
optional
ColdStratification
optional
DroughtTolerance
optional
FertilityRequirement
optional
FireTolerance
optional
MinFrostFreeDays
optional
HedgeTolerance
optional
MoistureUse
optional
pH_Minimum
optional
pH_Maximum
optional
Min_PlantingDensity
optional
Max_PlantingDensity
optional
Precipitation_Minimum
optional
Precipitation_Maximum
optional
RootDepthMinimum
optional
SalinityTolerance
optional
ShadeTolerance
optional
TemperatureMinimum
optional
BloomPeriod
optional
CommercialAvailability
optional
FruitSeedPeriodBegin
optional
FruitSeedPeriodEnd
optional
Propogated_by_BareRoot
optional
Propogated_by_Bulbs
optional
Propogated_by_Container
optional
Propogated_by_Corms
optional
Propogated_by_Cuttings
optional
Propogated_by_Seed
optional
Propogated_by_Sod
optional
Propogated_by_Sprigs
optional
Propogated_by_Tubers
optional
Seeds_per_Pound
optional
SeedSpreadRate
optional
SeedlingVigor
optional

GET /api/v1/species/:id

GET /api/beta/species/:id

Get all information about the row with the matching id value. Information about associated rows (those reference by foreign keys) is shown as well.

Params

Param name Description
key
optional

The API key to use for authorization.

associations_mode
optional

Set the amount of data to display about associations. Default is “full_info” for the show action and “count” for the index action.

Validations:

  • Must be one of: full_info, ids, count.