# bridgedb webservices API

> bridgedb webservices API on Apizie: 13 endpoints (Returns a list of xrefs and associated attributes that contain the query string for a given organism.…, Returns the supported attributes to the given Organism., Returns the attributes for a given identifier, data source, organism. Optionally display only a specified…, Returns `true` or `false` based on whether or not /{organism}/search/{query} is supported for a given…, …) returned as clean JSON through one API key. 13 endpoints are live now. Call it over REST at https://www.apizie.tech/v1/open-data:bridgedb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:bridgedb`
- Category: Open Data
- Status: live
- Source: https://bridgedb.org
- Page: https://www.apizie.tech/api/open-data/bridgedb
- OpenAPI: https://www.apizie.tech/api/open-data/bridgedb/openapi.json



## Endpoints

### Returns a list of xrefs and associated attributes that contain the query string for a given organism.…
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-attribute-search-query`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |
| query | string | yes | Text to find in attributes |
| limit | integer | no | Number of results |
| attrName | string | no | Restrict search by attribute name (case sensitive). Use GET /{organism}/attributeSet to find out which attributes are supported. |

### Returns the supported attributes to the given Organism.
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-attribute-set`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |

### Returns the attributes for a given identifier, data source, organism. Optionally display only a specified…
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-attributes-system-code-identifier`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |
| systemCode | string | yes | System |
| identifier | string | yes | Identifier |
| attrName | string | no | Type of attribute |

### Returns `true` or `false` based on whether or not /{organism}/search/{query} is supported for a given…
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-is-free-search-supported`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |

### Returns `true` or `false` based on whether or not /{organism}/xrefs/{systemCode}/{identifier} would possibly…
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-is-mapping-supported-source-system-code-target`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |
| sourceSystemCode | string | yes | [System code](http://vocabularies.bridgedb.org/#systemCode) for source (input/query) data source |
| targetSystemCode | string | yes | [System code](http://vocabularies.bridgedb.org/#systemCode) for target (output/result) data source |

### Returns the list of properties available for a given organism
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-properties`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |

### Returns a list of xrefs with identifiers that contain the query string for a given organism. Results are not…
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-search-query`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |
| query | string | yes | Identifier query |
| limit | integer | no | Number of results per data source |

### Returns a list of data sources available as xref sources for a given organism.
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-source-data-sources`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |

### Returns a list of data sources available as xref targets for a given organism.
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-target-data-sources`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |

### Returns `true` or `false` based on whether or not an xref exists in the database given an identifier, data…
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-xref-exists-system-code-identifier`

| Parameter | Type | Required | Description |
|---|---|---|---|
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |
| systemCode | string | yes | Source (input) data source [system code](https://bridgedb.github.io/pages/system-codes.html) |
| identifier | string | yes | Identifier |

### Returns a list of xrefs that map to a given identifier, data source, and organism.
`GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-xrefs-system-code-identifier`

| Parameter | Type | Required | Description |
|---|---|---|---|
| dataSource | string | no | (Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html) |
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |
| systemCode | string | yes | Source (input) data source [system code](https://bridgedb.github.io/pages/system-codes.html) |
| identifier | string | yes | Identifier |

### Returns a list of xrefs, per identifier, that maps to a given list of identifiers an data source given an…
`POST https://www.apizie.tech/v1/open-data:bridgedb/post-organism-xrefs-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| dataSource | string | no | (Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html) |
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |

### Returns a list of xrefs, that maps to a given list of identifiers to a given data source and organism.
`POST https://www.apizie.tech/v1/open-data:bridgedb/post-organism-xrefs-batch-system-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| dataSource | string | no | (Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html) |
| organism | string | yes | Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName). |
| systemCode | string | yes | Source (input) data source [system code](http://vocabularies.bridgedb.org/#systemCode) |

## Example
```
curl "https://www.apizie.tech/v1/open-data:bridgedb/get-organism-attribute-search-query" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the bridgedb webservices API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/open-data:bridgedb/get-organism-attribute-search-query with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the bridgedb webservices API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the bridgedb webservices API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:bridgedb.

### What is the status of the bridgedb webservices API?
Live: works with just an Apizie key