Python 2 Software Development Kit

Download the SDK

Note: This version of the SDK is no longer receiving updates. Updating to the Python 3 SDK is recommended.

Requirements

• Python 2.7.x
• IEEE Xplore API Access Key

Methods Overview

Note: Parameters are usually strings so they should have quotes around them.

Query Methods

Filter and Sort Methods

Results Methods

Running the Query and Getting Results

Defaults

• Data type defaults to JSON.
• Data format defaults to raw (the unmodified data string from the API).
• Position 1 in the set of results is the starting position.
• Results sort by Article Title and in ascending order (A-Z) by default; if the Content Type is set to ‘Standards’ then sorting is by Publication Year because Standards do not have some of the other sorting fields.
• Maximum number of results returned defaults to 25.

Examples

Italicized text in the examples below should be replaced with your desired values.

Query by Abstract Text

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.abstractText('query')
data = query.callAPI()  

Query by Affiliation

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.affiliationText('query')
data = query.callAPI()

Query by Article Number

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.articleNumber('article_number')
data = query.callAPI()

Query by Article Title

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.articleTitle('query')
data = query.callAPI()

Query by Author Facet

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.authorFacetText('query')
data = query.callAPI()

Query by Author Name

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.authorText('query')
data = query.callAPI()

Boolean Query

Searches all configured metadata fields, abstract, and document text.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.booleanText('boolean_query_without_parentheses')
data = query.callAPI()

Query by Open Content Type Facet

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.contentTypeFacetText('query')
data = query.callAPI()

Query by DOI (Digital Object Identifier)

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.doi(‘doi’)
data = query.callAPI()

Query by Open/Facet Value

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.facetText(‘query’)
data = query.callAPI()

Query by Index Terms

Queries text in Author Keywords, IEEE Terms, and Mesh Terms.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.indexTerms(‘terms’)
data = query.callAPI()

Query by ISBN

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.isbn(‘isbn’)
data = query.callAPI()

Query by ISSN

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.issn(‘issn’)
data = query.callAPI()

Query by Issue Number

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.issueNumber(‘issue_number’)
data = query.callAPI()

Query by Meta Data

Queries text in configured metadata fields and abstracts.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.metaDataText(‘query’)
data = query.callAPI()

Query for Open Access Article

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.openAccess(‘article number’)
data = query.callAPI()

Query by Publication Facet

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.publicationFacetText('query')
data = query.callAPI()

Query by Publisher Facet

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.publisherFacetText('query')
data = query.callAPI()

Query by Publication Title

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.publicationTitle('query')
data = query.callAPI()

Query by Publication Year

Note: Depending on publication the format of the year may vary.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.publicationYear(‘year’)
data = query.callAPI()

Query by Meta Data, Abstract, or Document Text

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
data = query.callAPI()

Query by Thesaurus Terms

Note: Thesaurus Terms are also called IEEE Terms.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.thesaurusTerms(‘terms’)
data = query.callAPI()

Query by Specific Data Field

This is a general-purpose method that accepts two parameters - the first is the field(s) to search, the second is the query.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.searchField(‘datafield’, ‘query’)
data = query.callAPI()

Query Involving Multiple Data Fields

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
query.publicationYear(‘year’)
data = query.callAPI()

Query Involving a Wildcard

Note: include no more than two wildcard words. Each wildcard word must have a minimum of three characters preceding the wildcard (*).

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText(‘query*’)
data = query.callAPI()

Query Involving Multiple Data Fields

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
query.publicationYear(‘year’)
data = query.callAPI()

Query Involving Filtering and Sorting of Results

Note: resultsFilter() can be called more than once, as long as a different data field is specified as its first parameter.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
query.startingResult(‘result_number’)
query.maximumResults(‘result_maximum_number’)
query.resultsFilter(‘data_field_name’,’filter_by_text’)
query.resultsSorting(‘data_field_name’,’sort_asc_or_desc’)
data = query.callAPI()

Query with XML String as Data Output

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
query.dataType(‘xml’)
query.dataFormat(‘raw’)
data = query.callAPI()

Query with ElementTree Object as Data Output

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
query.dataType(‘xml’)
query.dataFormat(‘object’)
data = query.callAPI()

Query with JSON String as Data Output

Note: Data type defaults to JSON.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
query.dataType(‘json’)
query.dataFormat(‘raw’)
data = query.callAPI()

Query with JSON Object as Data Output

Note: Data type defaults to JSON.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
query.dataType(‘json’)
query.dataFormat(‘object’)
data = query.callAPI()

Query with Debugging Enabled

Note: The query URL that would be sent to the API is output; no call is made to the API.

import xplore
query = xplore.xploreapi.XPLORE('api_access_key')
query.queryText('query')
data = query.callAPI(False)

Error Messages