API Documentation

You can use our Typesense search API at https://search.human-glycome.org to query the Human Glycome Database.

How to Use

All API requests require an API key. Please contact us by email to request your API key.

Endpoints & Example Requests

• Search: /collections/glycans/documents/search
• Get Collection Info: /collections/glycans
• Other endpoints: see examples below

Search Example

GET https://search.human-glycome.org/collections/glycans/documents/search?q=exampleQuery&per_page=100&query_by=documentId,monosaccharideComposition,glytoucanId,studies,studyAuthors
X-TYPESENSE-API-KEY: <your-api-key>
Content-Type: application/json

Get Collection Info

GET https://search.human-glycome.org/collections/glycans
X-TYPESENSE-API-KEY: <your-api-key>

Collection Schema

{
  "name": "glycans",
  "fields": [
    {"name": "documentId", "type": "string", "index": true, "infix": true},
    {"name": "mass", "type": "float", "index": true, "optional": true},
    {"name": "sialicDerivatization", "type": "bool", "index": false, "optional": true},
    {"name": "guMean", "type": "float", "index": true, "optional": true},
    {"name": "guMax", "type": "float", "index": false, "optional": true},
    {"name": "guMin", "type": "float", "index": false, "optional": true},
    {"name": "monosaccharideComposition", "type": "string", "index": true, "optional": true, "infix": true},
    {"name": "studies", "type": "string[]", "index": true, "optional": true, "infix": true},
    {"name": "species", "type": "string[]", "index": true, "optional": true},
    {"name": "stagesOfLife", "type": "string[]", "index": true, "optional": true, "infix": true},
    {"name": "sublocations", "type": "string[]", "index": true, "optional": true, "infix": true},
    {"name": "journals", "type": "string[]", "index": true, "optional": true, "infix": true},
    {"name": "years", "type": "string[]", "index": true, "optional": true, "infix": true},
    {"name": "doi", "type": "string[]", "index": true, "optional": true, "infix": true},
    {"name": "glytoucanId", "type": "string", "index": true, "optional": true, "infix": true},
    {"name": "structures", "type": "string[]", "index": true, "optional": true, "infix": true},
    {"name": "brainSpecific", "type": "bool", "index": true, "optional": true},
    {"name": "studyAuthors", "type": "string[]", "index": true, "optional": true, "infix": true}
  ]
}

Contact

For API access, support, or questions, email us at lbg@genos.hr.