Man pages for OpenMindat
Quickly Retrieve Datasets from the 'Mindat' API

ConvertDF2JsonLDOutput file as a given format
ConvertDF2TTLConvert a dataframe to a string of TTL format
crystalclasses_symbolscrystalclasses that match a given vector of symbols...
crystalclasses_systemscrystalclasses that match a given vector of crystal system...
Dana8_groupsdana_8 classification
Dana8_subgroupsdana_8 subgroups
geomaterials_bi_greater_thanretrieve the geomaterials whose birifrigence are higher than...
geomaterials_bi_less_thanretrieve the geomaterials whose birifrigence are lower...
geomaterials_bi_rangeretrieve the geomaterials whose birifrigence are higher and...
geomaterials_by_groupidretrieve the geomaterials by an given value of groupid.
geomaterials_cleavagetypegeomaterials that match an given cleavagetype
geomaterials_colourgeomaterials that have the given colors
geomaterials_contain_all_but_not_elemsgeomaterials that contain all of some given elements but...
geomaterials_contain_all_elemsgeomaterials_contain_all_elems
geomaterials_contain_any_but_not_elemsgeomaterials that contain any of some given elements but with...
geomaterials_contain_any_elemsgeomaterials that contain any one of the given elements
geomaterials_contain_only_elemsgeomaterials_contain_only_elems
geomaterials_crystal_systemgeomaterials that have the given crystal
geomaterials_dens_greater_thanretrieve the geomaterials whose density are higher than a...
geomaterials_dens_less_thanretrieve the geomaterials whose density are lower density...
geomaterials_dens_rangeretrieve the geomaterials whose density are within an given...
geomaterials_diaphenyretrieve the geomaterials that have an given diapheny.
geomaterials_entrytyperetrieve the geomaterials that have the given entrytype
geomaterials_expandretrieve the geomaterials that have the given expand.
geomaterials_field_existsretrieve the geomaterials records of empty or not empty of a...
geomaterials_fracturetyperetrieve the geomaterials that have the given fracturetype.
geomaterials_hardness_gtretrieve the geomaterials whose hardness are higher than an...
geomaterials_hardness_ltretrieve the geomaterials whose hardness are lower than an...
geomaterials_hardness_rangeretrieve the geomaterials whose hardness is within the given...
geomaterials_imaretrieve the geomaterials approved by IMA or not.
geomaterials_ima_notesretrieve the geomaterials match given notes.
geomaterials_ima_statusretrieve the geomaterials matched given IMA status.
geomaterials_lustretyperetrieve the geomaterials that match an given lustretype.
geomaterials_meteoritical_coderetrieve the geomaterials matched a given string in its...
geomaterials_nameretrieve the geomaterials matched a given string in its name.
geomaterials_not_contain_elemsgeomaterials that do not contain the elements
geomaterials_optical2v_maxretrieve the geomaterials that less than the given optical...
geomaterials_optical2v_minretrieve the geomaterials that has higher value than the...
geomaterials_optical2v_rangeretrieve the geomaterials that has the given range of optical...
geomaterials_opticalsignretrieve the geomaterials that match an given optical signs.
geomaterials_opticaltyperetrieve the geomaterials that match an given optical type.
geomaterials_polytypeofretrieve the geomaterials by an given id of polytype of (the...
geomaterials_ri_gtretrieve the geomaterials that refractive index higher than...
geomaterials_ri_ltretrieve the geomaterials that refractive index lower than an...
geomaterials_ri_rangeretrieve the geomaterials whose refractive index is within an...
geomaterials_search_nameretrieve the geomaterials by a given name.
geomaterials_streakretrieve the geomaterials that match an given streak.
geomaterials_synidretrieve the geomaterials by an given synid.
geomaterials_updated_atretrieve the geomaterials updated at an given time.
geomaterials_varietyofretrieve the geomaterials that are varieties of an given id...
geomeaterials_non_utfretrieve the geomaterials that include non-utf mineral names...
geomeaterials_orderingretrieve the geomaterials by an given ordering.
getExtensionOutput the file extension of a filename
localities_list_allretrieve the localities list.
localities_list_countryretrieve the localities list that are belong to a given...
localities_list_descriptionretrieve the localities that contain the given description
localities_list_elems_exclocalities that do not contain the given elements
localities_list_elems_inclocalities that contain the given elements
localities_list_elems_inc_exclocalities that contain the given elements but not contain...
localities_list_expandlocalities that contain the given expands.
localities_list_txtlocalities that contain the given txt name.
localities_list_updated_atretrieve the localities list updated at the given time.
localities_retrieve_idretrieve the localities by a given mindat id.
localities_status_listlocalities_status_list
localities_status_retrievelocalities_status_retrieve
localitiy_type_retrievelocalitiy_type_retrieve
locality_agelocality_age
locality_age_listlocality_age_list
locality_type_listlocality_type_list
Locentries_listretrieve a full list of locacentries.
Locentries_retrieveretrieve locacentries by given a Locentry ID.
Locentries_stat_retrieveretrieve locacentries statstics by given a Locentry ID.
Locentries_statstics_listretrieve a full list of locacentries statstics.
mindat_build_querystringmindat_build_querystring
mindat_cache_deleteDelete a cached value by the users input varname
mindat_cache_emptyRemove all cached values
mindat_cache_getGet cache value
mindat_cache_hasCheck if the current environment has the cached value of...
mindat_cache_return_or_setupCheck if the current environment has the cached function...
mindat_cache_setSet cache name and value
mindat_connectionInitializing Mindat API
mindat_countriesmindat_countries
mindat_countrymindat_country
mindat_crystalclassesmindat_crystalclasses
mindat_crystalclass_listmindat_crystalclass_list
mindat_dana8_groupsmindat_dana8_groups
mindat_dana8_subgroupsmindat_dana8_subgroups
mindat_extract_response_bodymindat_extract_response_body
mindat_geomaterialmindat_geomaterial
mindat_geomaterial_listmindat_geomaterial_list
mindat_geomaterial_searchmindat_geomaterial_search
mindat_geomaterial_varietiesmindat_geomaterial_varieties
mindat_get_data_from_urimindat_get_data_from_uri
mindat_localities_listmindat_localities_list
mindat_localitiymindat_localitiy
mindat_locality_statusmindat_locality_status
mindat_locality_status_listmindat_locality_status_list
mindat_locality_typemindat_locality_type
mindat_locality_type_listmindat_locality_type_list
mindat_locentries_listmindat_locentries_list
mindat_locentries_lstm_idmindat_locentries_lstm_id
mindat_locentries_retrievemindat_locentries_retrieve
mindat_locentries_statmindat_locentries_stat
mindat_make_data_framemindat_make_data_frame
mindat_mineral_imamindat_mineral_ima
mindat_mineral_ima_listmindat_mineral_ima_list
mindat_nickel_strunz10_classesmindat_nickel_strunz10_classes
mindat_nickel_strunz10_familiesmindat_nickel_strunz10_families
mindat_nickel_strunz10_subclassesmindat_nickel_strunz10_subclasses
mindat_parse_raw_datamindat_parse_raw_data
mindat_querymindat_query
mindat_setupmindat_setup
mindat_spacegroupsmindat_spacegroups
mindat_spacegroupsetsmindat_spacegroupsets
mindat_spacegroupsets_listmindat_spacegroupsets_list
mindat_spacegroups_listmindat_spacegroups_list
minerals_ima_listminerals_ima_list
minerals_ima_list_expandminerals_ima_list_expand
minerals_ima_list_imaminerals_ima_list_ima
minerals_ima_retrieveminerals_ima_retrieve
minerals_ima_updated_atretrieve the mineral_ima list updated at the given time.
Nickel_strunz10_classesNickel-strunz10-classes
Nickel_strunz10_familiesNickel-strunz10-families
Nickel_strunz10_subclassesNickel-strunz10-subclasses
OpenMindat-packageOpenMindat: Quickly Retrieve Datasets from the 'Mindat' API
params_to_stringparams_to_string
saveMindatDataAsOutput file as a given format
set_api_baseset_api_base
set_api_tokenset_api_token
set_page_sizeset_page_size
spacegroups_by_idspacegroups that match a given spacegroup ID (integer)
spacegroups_cclassspacegroups that match a given crystalclass ID (integer)
spacegroupsets_by_idspacegroupsets that match a given spacegroupets ID (integer)
spacegroupsets_cclassspacegroupsets that match a given crystalclass ID (integer)
spacegroupsets_listreturn a full list of spacegroupsetsets
spacegroupsets_sgtextspacegroupsets that match a given sgtext (string)
spacegroups_listreturn a full list of spacegroups
spacegroups_sgtextspacegroups that match a given sgtext (string)
OpenMindat documentation built on June 8, 2025, 1:47 p.m.