CoreMarketplace Facility API documentation
The CoreMarketplace recently updated its API engine. To access the documentation regarding the API please visit https://api.coremarketplace.org/apps/swagger-ui
If you are using the profile export feature, please update the URI to the following:
https://api.coremarketplace.org/profile/export/[YOUR_RRID]
where [YOUR_RRID] = your facility's full RRID, ex: RRID:SCR_012345
A successful query will generate a response similar to below in either json or xml format:
{
"Contact": {
"FacilityName": "My Facility Name",
"Institution": "My Institution",
"RORID": "https:\/\/ror.org\/my_ror_id",
"Website": "https:\/\/www.my-url.org\/research\/research-technologies\/bioinformatics",
"AltLink2": "https:\/\/coremarketplace.org\/RRID:MY_RRID",
"PrimaryContact": [
{
"Name": "John Doe",
"Phone": null
}
]
},
"Citation": {
"FacilityRRID": "RRID:MY_RRID",
"CitationLink": "https:\/\/coremarketplace.org\/RRID:MY_RRID?citation=1",
"CiteFacilityTag": "My Facility Citation String Info"
},
"Description": {
"Description": "Description of core facility",
"ServiceOutsideInstitution": "Yes",
"ConsultingOutsideInstitution": "Yes",
"IsCommercialFacility": "No"
},
"LastUpdated": "1729148482"
}
The API engine expects requests to send a User-Agent in the header. This happens automatically in a web browser. If you are calling the API in code, be sure to set this header or the API won't respond as expected. An example (using PHP) might look something like this:
$MY_RRID = "RRID:SCR_123456";
$url = "https://api.coremarketplace.org/profile/export/$MY_RRID";
$options = array('http' => array('user_agent' => 'custom user agent string'));
$context = stream_context_create($options);
$response = file_get_contents($url, false, $context);