JASPAR API
This API provides easy-to-use REST web interface to query/retrieve matrix profile data from the latest version of JASPAR database. The API comes with a human browsable interface and also programmatic interface, which return the results in eight different formats, including json
, jsonp
, jaspar
, meme
, transfac
, pfm
, yaml
and bed
collections
list
List all the collections are available in JASPAR.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
order | Which field to use when ordering the results. |
release | Access a specific release of JASPAR. Available releases are: 2014, 2016, 2018 and 2020. If blank it will pull data from latest release seven (JASPAR 2020). |
read
API endpoint that returns a list of all matrix profiles based on collection name.
Collection names are: 'CORE', 'CNE', 'PHYLOFACTS', 'SPLICE', 'POLII', 'FAM','PBM','PBM_HOMEO','PBM_HLH', 'UNVALIDATED'
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
collection required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
order | Which field to use when ordering the results. |
version | If set to latest, return latest version |
release | Access a specific release of JASPAR. Available releases are: 2014, 2016, 2018 and 2020. If blank it will pull data from latest release seven (JASPAR 2020). |
infer
read
Infer matrix profiles, given protien sequence
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
sequence required |
live
matrix
list
REST API endpoint that returns a list of all matrix profiles.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
order | Which field to use when ordering the results. |
collection | JASPAR Collection name. For example: CORE or CNE. |
name | Search by TF name (case-sensitive). For example: SMAD3 |
tax_group | Taxonomic group. For example: Vertebrates |
tax_id | Taxa ID. For example: 9606 for Human & 10090 for Mus musculus. Multiple IDs can be added separated by commas (e.g. tax_id=9606,10090). |
tf_class | Transcription factor class. For example: Zipper-Type |
tf_family | Transcription factor family. For example: SMAD factors |
data_type | Type of data/experiment. For example: ChIP-seq, PBM, SELEX etc. |
version | If set to latest, return latest version |
release | Access a specific release of JASPAR. Available releases are: 2014, 2016, 2018 and 2020. If blank it will pull data from latest release seven (JASPAR 2020). |
read
Gets profile detail information
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
matrix_id required |
versions > list
List matrix profile versions based on base_id
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
base_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order | Which field to use when ordering the results. |
releases
list
REST API endpoint that returns all releases of JASPAR database.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
order | Which field to use when ordering the results. |
read
Gets JASPAR release information based on release number
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
release_number required |
sites
read
List matrix profile sites based on matrix_id
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
matrix_id required |
species
list
API endpoint that returns a list of all species.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
order | Which field to use when ordering the results. |
release | Access a specific release of JASPAR. Available releases are: 2014, 2016, 2018 and 2020. If blank it will pull data from latest release seven (JASPAR 2020). |
read
API endpoint that returns a list of all matrix profiles based on species.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
tax_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
order | Which field to use when ordering the results. |
version | If set to latest, return latest version |
release | Access a specific release of JASPAR. Available releases are: 2014, 2016, 2018 and 2020. If blank it will pull data from latest release seven (JASPAR 2020). |
taxon
list
List all the collections are available in JASPAR.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
release | Access a specific release of JASPAR. Available releases are: 2014, 2016, 2018 and 2020. If blank it will pull data from latest release seven (JASPAR 2020). |
read
API endpoint that returns a list of all matrix profiles based on taxonomic group.
Available taxonomic groups are: vertebrates, plants, insects, nematodes, fungi, urochordates
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
tax_group required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
order | Which field to use when ordering the results. |
version | If set to latest, return latest version |
release | Access a specific release of JASPAR. Available releases are: 2014, 2016, 2018 and 2020. If blank it will pull data from latest release seven (JASPAR 2020). |
tffm
list
REST API endpoint that returns a list of all TFFM profiles.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
order | Which field to use when ordering the results. |
tax_group | Taxonomic group. For example: Vertebrates or Plants |
release | Access a specific release of JASPAR. Available releases are: 2014, 2016, 2018 and 2020. If blank it will pull data from latest release seven (JASPAR 2020). |
read
Gets TFFM detail information
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
tffm_id required |