APIHub
Back to Explore

bridgedb webservices

bridgedb webservices

Uncategorized
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/{organism}/xrefsBatch

Returns a list of xrefs, per identifier, that maps to a given list of identifiers an data source given an organism.

  • dataSource (query) — (Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html)
  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
GET

/{organism}/attributeSearch/{query}

Returns a list of xrefs and associated attributes that contain the query string for a given organism. Results are not restricted to exact matches. Optionally limit results to a specified number per data source, or by the type of attribute. See possible attribute types via /{organism}/attributeSet.

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
  • query (path, required) — Text to find in attributes
  • limit (query, limit) — Number of results
  • attrName (query) — Restrict search by attribute name (case sensitive). Use GET /{organism}/attributeSet to find out which attributes are supported.
GET

/{organism}/attributeSet

Returns the supported attributes to the given Organism.

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
GET

/{organism}/attributes/{systemCode}/{identifier}

Returns the attributes for a given identifier, data source, organism. Optionally display only a specified attribute

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
  • systemCode (path, required) — System
  • identifier (path, required) — Identifier
  • attrName (query) — Type of attribute
GET

/{organism}/isFreeSearchSupported

Returns `true` or `false` based on whether or not /{organism}/search/{query} is supported for a given organism.

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
GET

/{organism}/isMappingSupported/{sourceSystemCode}/{targetSystemCode}

Returns `true` or `false` based on whether or not /{organism}/xrefs/{systemCode}/{identifier} would possibly return a {targetSystemCode} result given a {sourceSystemCode} query. This function basically combines the results of /{organism}/sourceDataSources and /{organism}/targetDataSources into a single boolean result.

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
  • sourceSystemCode (path, required) — [System code](http://vocabularies.bridgedb.org/#systemCode) for source (input/query) data source
  • targetSystemCode (path, required) — [System code](http://vocabularies.bridgedb.org/#systemCode) for target (output/result) data source
GET

/{organism}/properties

Returns the list of properties available for a given organism

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
GET

/{organism}/search/{query}

Returns a list of xrefs with identifiers that contain the query string for a given organism. Results are not restricted to exact matches. Optionally limit results to a specified number per data source.

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
  • query (path, required) — Identifier query
  • limit (query, limit) — Number of results per data source
GET

/{organism}/sourceDataSources

Returns a list of data sources available as xref sources for a given organism.

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
GET

/{organism}/targetDataSources

Returns a list of data sources available as xref targets for a given organism.

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
GET

/{organism}/xrefExists/{systemCode}/{identifier}

Returns `true` or `false` based on whether or not an xref exists in the database given an identifier, data source, and organism.

  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
  • systemCode (path, required) — Source (input) data source [system code](https://bridgedb.github.io/pages/system-codes.html)
  • identifier (path, required) — Identifier
GET

/{organism}/xrefs/{systemCode}/{identifier}

Returns a list of xrefs that map to a given identifier, data source, and organism.

  • dataSource (query) — (Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html)
  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
  • systemCode (path, required) — Source (input) data source [system code](https://bridgedb.github.io/pages/system-codes.html)
  • identifier (path, required) — Identifier
POST

/{organism}/xrefsBatch/{systemCode}

Returns a list of xrefs, that maps to a given list of identifiers to a given data source and organism.

  • dataSource (query) — (Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html)
  • organism (path, required) — Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).
  • systemCode (path, required) — Source (input) data source [system code](http://vocabularies.bridgedb.org/#systemCode)

13 endpoints auto-detected

curl -X POST \
  "https://webservice.bridgedb.org/{organism}/xrefsBatch"

webservice.bridgedb.org · HTTPS only