How to get Bibtex Works Citations from API v3? *automating get bibtex from ORCIDs*

249 views
Skip to first unread message

Job Diogenes Ribeiro Borges

unread,
Apr 4, 2022, 4:50:08 PM4/4/22
to ORCID API Users
When API v1.X was working we could generate bibtex using
[work-citation][citation] fields.

Now these fields does not exist more.

Ok,  users could  export Bibitex. But I could not found a way to 
get this bibtex export even after get users OAUTH 

Any ideias?

Thanks

Fran Alsina

unread,
Apr 28, 2022, 7:44:18 AM4/28/22
to ORCID API Users
Hi there, 

 If the bibtex citation is in the metadata of the publication item, you can do a GET item call to obtain the citation in the XML/JSON metadata. 

Bear in mind that in order for you to obtain the bibtex citation, you would have to do a GET call to the specific item (/work/PUT-CODE) and not the work sections in general (/works). If you do a GET /works call, you will get a summarized response of all the work items of that record. This summarized response does not contain the bibtex citation. 

 Find here an API call example: 


 And the API response example in XML: 

<common:created-date>2022-04-10T12:53:45.064Z</common:created-date>
   <common:last-modified-date>2022-04-10T12:53:45.064Z</common:last-modified-date>
   <common:source>
       <common:source-client-id>
           <common:uri>https://orcid.org/0000-0002-XXXX-XXXX</common:uri>
           <common:path>0000-0002-XXXX-XXXX</common:path>
           <common:host>orcid.org</common:host>
       </common:source-client-id>
       <common:source-name>Europe PubMed Central</common:source-name>
       <common:assertion-origin-orcid>
           <common:uri>https://orcid.org/client/0000-0002-XXXX-XXXX</common:uri>
           <common:path>0000-0003-XXXX-XXXX</common:path>
           <common:host>orcid.org</common:host>
       </common:assertion-origin-orcid>
       <common:assertion-origin-name>John Doe</common:assertion-origin-name>
   </common:source>
   <work:title>
       <common:title>Work Title</common:title>
   </work:title>
   <work:journal-title>Journal Title</work:journal-title>
   <work:citation>
       <work:citation-type>bibtex</work:citation-type>
       <work:citation-value>@article{PMID:12345,
 title = {This is the Work Title.},
 author = {Author One, Author Two},
 doi = {10.12345/s1234},
 journal = {This is the Journal Title},
 month = {04},
 year = {2022}
}</work:citation-value>

   </work:citation>
   <work:type>journal-article</work:type>
   <common:publication-date>
       <common:year>2022</common:year>
       <common:month>04</common:month>
   </common:publication-date>
   <common:external-ids>
       <common:external-id>
           <common:external-id-type>pmid</common:external-id-type>
           <common:external-id-value>12345</common:external-id-value>
           <common:external-id-normalized transient="true">12345</common:external-id-normalized>
           <common:external-id-relationship>self</common:external-id-relationship>
       </common:external-id>
       <common:external-id>
           <common:external-id-type>doi</common:external-id-type>
           <common:external-id-value>10.12345/s1234</common:external-id-value>
           <common:external-id-normalized transient="true">10.12345/s1234</common:external-id-normalized>
           <common:external-id-url>https://doi.org/10.12345/s1234</common:external-id-url>
           <common:external-id-relationship>self</common:external-id-relationship>
       </common:external-id>
   </common:external-ids>
   <common:url>http://europepmc.org/abstract/med/12345</common:url>
   <work:contributors>
       <work:contributor>
           <work:credit-name>Contributor One</work:credit-name>
           <work:contributor-attributes>
               <work:contributor-sequence>first</work:contributor-sequence>
               <work:contributor-role>author</work:contributor-role>
           </work:contributor-attributes>
       </work:contributor>
       <work:contributor>
           <work:credit-name>Contributor Two</work:credit-name>
           <work:contributor-attributes>
               <work:contributor-sequence>first</work:contributor-sequence>
               <work:contributor-role>author</work:contributor-role>
           </work:contributor-attributes>
       </work:contributor>
       <work:contributor>
           <work:credit-name>Contributor Three</work:credit-name>
           <work:contributor-attributes>
               <work:contributor-sequence>first</work:contributor-sequence>
               <work:contributor-role>author</work:contributor-role>
           </work:contributor-attributes>
       </work:contributor>
   </work:contributors>
</work:work>

I hope that this helps and answers your questions regarding citations. 

 Best regards,

Job Diogenes Ribeiro Borges

unread,
May 20, 2022, 3:32:50 PM5/20/22
to ORCID API Users
Great, thanks very much. 
Message has been deleted

Claudio Vergari

unread,
Jun 26, 2024, 10:06:59 AM6/26/24
to ORCID API Users
Hi,

I am trying to use the bibtex field as well, but it seems that it is not always present. Actually, I only rarely find it.
Is there any way to get it systematically, or to know in advance (from the works list) if it is present?

Thanks in advance!

Jordan Holt

unread,
Jul 15, 2024, 8:40:56 AM7/15/24
to ORCID API Users

Hi, 

Thanks for your question.

The presence of the BibTeX field depends on whether the source of the work item has included this information. Not all sources provide this, as it is an optional field.

BibTeX citations are not present in the works summary endpoint (/works). You can check if the BibTeX field is present by performing an HTTP GET request to the specific work item using its put code (/work/PUT-CODE). When retrieving a work item, look for the citation-type field. If the citation-type is "bibtex," then the BibTeX data should be available.

Here's an example of how you can do this: curl -H "Accept: application/json" "https://pub.orcid.org/v3.0/[ORCID_ID]/work/[PUT_CODE]"

The response will include detailed information about the work item, and you can check for the presence of the citation-type field to see if it includes "bibtex".

Claudio Vergari

unread,
Jul 15, 2024, 9:37:12 AM7/15/24
to ORCID API Users
Thanks! My question was more along the lines of getting the information on bibtex availability from the summary list of works, to avoid having to request each work independently to check. I guess that's not possible, but I found a way to avoid making a specific GET request for each work by storing locally the DOIs that I already checked, so at least I don't check them twice.
Thanks again!
Reply all
Reply to author
Forward
0 new messages