Skill Tracer
Skills › Scientific Agent Skills › database-lookup › addgene.md

addgene.md

40 lines · skills/database-lookup/references/addgene.md at 5f2bc03

Open on GitHub
1# Addgene Catalog API
2

Addgene Catalog API

Raw lines 1 to 2
3## Access and authentication
4
5Base: `https://api.developers.addgene.org`. Access requires approval and a license
6for each requested scope; a normal Addgene account does not grant API access.
7Use `Authorization: Token <ADDGENE_API_KEY>`.
8

Access and authentication

Base: https://api.developers.addgene.org. Access requires approval and a license for each requested scope; a normal Addgene account does not grant API access. Use Authorization: Token <ADDGENE_API_KEY>.

Raw lines 3 to 8
9## Read endpoints
11| GET path | Purpose |
12|---|---|
13| `/catalog/plasmid/` | Search/list plasmids |
14| `/catalog/plasmid/{id}/` | One plasmid |
15| `/catalog/plasmid-with-sequences/{id}/` | One plasmid with sequences; requires `catalog:retrieve-with-sequences` |
16| `/catalog/viral-prep/` | List viral preparations |
17| `/catalog/viral-prep/{id}/` | One viral preparation |
19Ordinary catalog reads require `catalog:retrieve` or the sequence-enabled scope.
20Use `q` for free text; documented field filters include `name`, `backbone`,
21`genes`, `article_pmid`, and `species`. List responses contain `count`, `next`,
22`previous`, and `results`. Follow `next`; `page` and `page_size` control pagination.
23Use `sort_by=id` for stable pagination; relevance sorting requires `q`.
25Illustrative authenticated request (not executed):
27```bash
28curl --fail-with-body --get 'https://api.developers.addgene.org/catalog/plasmid/' \
29 -H "Authorization: Token ${ADDGENE_API_KEY}" \
30 --data-urlencode 'q=GFP' --data-urlencode 'sort_by=id' \
31 --data-urlencode 'page_size=5'
32```
34Plasmid records include cloning, insert, sequence, and article data according to
35scope; nullable fields and empty arrays are legitimate. Use licensed daily JSON
36bulk downloads for large retrievals. The old `/api/plasmids`, `/depositors`, and
37`/articles` routes are not the documented developer API.
39Reviewed 2026-09-30: [OpenAPI schema](https://docs.developers.addgene.org/docs/schema/)
40and [access requirements](https://developers.addgene.org/access-options/).

Read endpoints

GET pathPurpose
/catalog/plasmid/Search/list plasmids
/catalog/plasmid/{id}/One plasmid
/catalog/plasmid-with-sequences/{id}/One plasmid with sequences; requires catalog:retrieve-with-sequences
/catalog/viral-prep/List viral preparations
/catalog/viral-prep/{id}/One viral preparation

Ordinary catalog reads require catalog:retrieve or the sequence-enabled scope. Use q for free text; documented field filters include name, backbone, genes, article_pmid, and species. List responses contain count, next, previous, and results. Follow next; page and page_size control pagination. Use sort_by=id for stable pagination; relevance sorting requires q.

Illustrative authenticated request (not executed):

curl --fail-with-body --get 'https://api.developers.addgene.org/catalog/plasmid/' \
  -H "Authorization: Token ${ADDGENE_API_KEY}" \
  --data-urlencode 'q=GFP' --data-urlencode 'sort_by=id' \
  --data-urlencode 'page_size=5'

Plasmid records include cloning, insert, sequence, and article data according to scope; nullable fields and empty arrays are legitimate. Use licensed daily JSON bulk downloads for large retrievals. The old /api/plasmids, /depositors, and /articles routes are not the documented developer API.

Reviewed 2026-09-30: OpenAPI schema and access requirements.

Raw lines 9 to 40