TIN-X REST API

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

articles

list

GET /articles/

Browse and search all Pubmed articles in the database.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`title`
`journal`
`author`
`abstract`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action articles list -p limit=... -p offset=... -p search=... -p title=... -p journal=... -p author=... -p abstract=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "list"]
var params = {
    limit: ...,
    offset: ...,
    search: ...,
    title: ...,
    journal: ...,
    author: ...,
    abstract: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["articles", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
    "title": ...,
    "journal": ...,
    "author": ...,
    "abstract": ...,
}
result = client.action(schema, action, params=params)

read

GET /articles/{id}/

Retrieve information about a specific Pubmed article.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`title`
`journal`
`author`
`abstract`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action articles read -p id=... -p search=... -p title=... -p journal=... -p author=... -p abstract=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "read"]
var params = {
    id: ...,
    search: ...,
    title: ...,
    journal: ...,
    author: ...,
    abstract: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["articles", "read"]
params = {
    "id": ...,
    "search": ...,
    "title": ...,
    "journal": ...,
    "author": ...,
    "abstract": ...,
}
result = client.action(schema, action, params=params)

diseases

list

GET /diseases/

Browse all diseases in the database.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`doid`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action diseases list -p limit=... -p offset=... -p search=... -p doid=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["diseases", "list"]
var params = {
    limit: ...,
    offset: ...,
    search: ...,
    doid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["diseases", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
    "doid": ...,
}
result = client.action(schema, action, params=params)

read

GET /diseases/{id}/

Get information about a specific disease.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`doid`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action diseases read -p id=... -p search=... -p doid=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["diseases", "read"]
var params = {
    id: ...,
    search: ...,
    doid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["diseases", "read"]
params = {
    "id": ...,
    "search": ...,
    "doid": ...,
}
result = client.action(schema, action, params=params)

children

GET /diseases/{id}/children/

Retrieve a list of this disease's children.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action diseases children -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["diseases", "children"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["diseases", "children"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

parent

GET /diseases/{id}/parent/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action diseases parent -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["diseases", "parent"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["diseases", "parent"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

targets > list

GET /diseases/{disease_id}/targets/

View targets associated with a specific disease.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`disease_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`uniprot`
`sym`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action diseases targets &gt; list -p disease_id=... -p limit=... -p offset=... -p search=... -p uniprot=... -p sym=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["diseases", "targets &gt; list"]
var params = {
    disease_id: ...,
    limit: ...,
    offset: ...,
    search: ...,
    uniprot: ...,
    sym: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["diseases", "targets &gt; list"]
params = {
    "disease_id": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "uniprot": ...,
    "sym": ...,
}
result = client.action(schema, action, params=params)

targets > read

GET /diseases/{disease_id}/targets/{id}

Retrieve information about a specific disease-target association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`disease_id` required
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`uniprot`
`sym`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action diseases targets &gt; read -p disease_id=... -p id=... -p search=... -p uniprot=... -p sym=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["diseases", "targets &gt; read"]
var params = {
    disease_id: ...,
    id: ...,
    search: ...,
    uniprot: ...,
    sym: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["diseases", "targets &gt; read"]
params = {
    "disease_id": ...,
    "id": ...,
    "search": ...,
    "uniprot": ...,
    "sym": ...,
}
result = client.action(schema, action, params=params)

targets > articles > list

GET /diseases/{disease_id}/targets/{target_id}/articles

Browse and search all Pubmed articles in the database.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`disease_id` required
`target_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`title`
`journal`
`author`
`abstract`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action diseases targets &gt; articles &gt; list -p disease_id=... -p target_id=... -p limit=... -p offset=... -p search=... -p title=... -p journal=... -p author=... -p abstract=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["diseases", "targets &gt; articles &gt; list"]
var params = {
    disease_id: ...,
    target_id: ...,
    limit: ...,
    offset: ...,
    search: ...,
    title: ...,
    journal: ...,
    author: ...,
    abstract: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["diseases", "targets &gt; articles &gt; list"]
params = {
    "disease_id": ...,
    "target_id": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "title": ...,
    "journal": ...,
    "author": ...,
    "abstract": ...,
}
result = client.action(schema, action, params=params)

dto

list

GET /dto/

Browse and search all DTO entities in our database.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`has_parent`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action dto list -p limit=... -p offset=... -p search=... -p has_parent=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dto", "list"]
var params = {
    limit: ...,
    offset: ...,
    search: ...,
    has_parent: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["dto", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
    "has_parent": ...,
}
result = client.action(schema, action, params=params)

read

GET /dto/{id}/

Retrieve information about a specific DTO entity,

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this dto.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`has_parent`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action dto read -p id=... -p search=... -p has_parent=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dto", "read"]
var params = {
    id: ...,
    search: ...,
    has_parent: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["dto", "read"]
params = {
    "id": ...,
    "search": ...,
    "has_parent": ...,
}
result = client.action(schema, action, params=params)

children

GET /dto/{id}/children/

Retrieve the list of children for a given DTO entity.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this dto.

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action dto children -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dto", "children"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["dto", "children"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

search

list

GET /search/

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action search list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["search", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["search", "list"]
result = client.action(schema, action)

targets

list

GET /targets/

Browse all targets in the database.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`name`
`uniprot`
`sym`
`fam`
`famext`
`tdl`
`in_dto`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action targets list -p limit=... -p offset=... -p search=... -p name=... -p uniprot=... -p sym=... -p fam=... -p famext=... -p tdl=... -p in_dto=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["targets", "list"]
var params = {
    limit: ...,
    offset: ...,
    search: ...,
    name: ...,
    uniprot: ...,
    sym: ...,
    fam: ...,
    famext: ...,
    tdl: ...,
    in_dto: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["targets", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
    "name": ...,
    "uniprot": ...,
    "sym": ...,
    "fam": ...,
    "famext": ...,
    "tdl": ...,
    "in_dto": ...,
}
result = client.action(schema, action, params=params)

read

GET /targets/{id}/

Get information about a specific target.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`name`
`uniprot`
`sym`
`fam`
`famext`
`tdl`
`in_dto`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action targets read -p id=... -p search=... -p name=... -p uniprot=... -p sym=... -p fam=... -p famext=... -p tdl=... -p in_dto=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["targets", "read"]
var params = {
    id: ...,
    search: ...,
    name: ...,
    uniprot: ...,
    sym: ...,
    fam: ...,
    famext: ...,
    tdl: ...,
    in_dto: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["targets", "read"]
params = {
    "id": ...,
    "search": ...,
    "name": ...,
    "uniprot": ...,
    "sym": ...,
    "fam": ...,
    "famext": ...,
    "tdl": ...,
    "in_dto": ...,
}
result = client.action(schema, action, params=params)

diseases > list

GET /targets/{target_id}/diseases/

View the diseases associated with a specific target.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`target_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action targets diseases &gt; list -p target_id=... -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["targets", "diseases &gt; list"]
var params = {
    target_id: ...,
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["targets", "diseases &gt; list"]
params = {
    "target_id": ...,
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

diseases > read

GET /targets/{target_id}/diseases/{id}/

Retrieve information about a specific target-disease association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`target_id` required
`id` required

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action targets diseases &gt; read -p target_id=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["targets", "diseases &gt; read"]
var params = {
    target_id: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["targets", "diseases &gt; read"]
params = {
    "target_id": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

diseases > articles > list

GET /targets/{target_id}/diseases/{disease_id}/articles

Browse and search all Pubmed articles in the database.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`target_id` required
`disease_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`title`
`journal`
`author`
`abstract`

# Load the schema document
$ coreapi get http://api.newdrugtargets.org/docs/

# Interact with the API endpoint
$ coreapi action targets diseases &gt; articles &gt; list -p target_id=... -p disease_id=... -p limit=... -p offset=... -p search=... -p title=... -p journal=... -p author=... -p abstract=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["targets", "diseases &gt; articles &gt; list"]
var params = {
    target_id: ...,
    disease_id: ...,
    limit: ...,
    offset: ...,
    search: ...,
    title: ...,
    journal: ...,
    author: ...,
    abstract: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.newdrugtargets.org/docs/")

# Interact with the API endpoint
action = ["targets", "diseases &gt; articles &gt; list"]
params = {
    "target_id": ...,
    "disease_id": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "title": ...,
    "journal": ...,
    "author": ...,
    "abstract": ...,
}
result = client.action(schema, action, params=params)