Introduction

Anyone can access and use the VitalDB platform by application programming interface (API). All API’s can be called using the HTTPS standard protocol.

Endpoints

Login API

Issue an access token which is required to access VitalDB APIs.

Endpoint

https://vitaldb.net/api/login

Method

POST

Parameters

Please url-encode (RFC1738) the parameters if it has any special characters.

Return Value

Content-type: application/json

Sample Codes

curl -v -d “id=userid&pw=password” https://vitaldb.net/api/login

Web Monitoring API

A protocol for uploading vital signs data to VitalDB web monitoring.

Send

Upload real-time vital sign data of inputted vrcode to Web Monitoring.

Endpoint

https://vitaldb.net/api/send

Method

POST

Parameters

Please url-encode (RFC1738) the parameters if it has any special characters.

Each room is formatted as follows:

Each device is formatted as follows:

Each track is formatted as follows:

Sample Data

A sample data string in JSON is as below.

sampledata = '{"ver":"1.8.8.3","vrcode":"9a9uewrsv","rooms":[{"roomname":"DEMO","seqid":59,"dtstart":1607071644.806051,"dtend":1607071645.808981,"dtcase":1607071590.292408,"ptcon":1,"dtapp":1607071577.160322,"recording":1,"dgmt":-32400,"devs":[{"type":"Demo","name":"Demo","status":"on","ycable":"0","port":""}],"trks":[{"id":2109467744,"name":"EEG","type":"wav","montype":"EEGWAV","srate":100,"mindisp":-100,"maxdisp":100,"color":"#dda0dd","unit":"uV","recs":[{"dt":1607071644.806051,"val":[-56.75,-58.05,-61,-65.2,-69.35,-71.05,-69.95,-66.65,-62.2,-54.05,-54.05,-55.05,-56.25,-61.15,-65.25,-68.15,-65.3,-63.4,-59,-53.7,-51.05,-50.85,-52.4,-56.65,-59.3,-62.1,-65.55,-65.8,-62.25,-58.95,-54.9,-50.65,-49.95,-49.95,-47.35,-46,-46.35,-46.7,-49.95,-52.65,-55.9,-59.5,-57.95,-55.25,-53.35,-49.4,-49.4,-53.05,-59,-56.9,-52.4,-47.1,-35,-32.9,-32.5,-31.9,-36.1,-38.75,-43.25,-49.55,-51.95,-54.9,-53.55,-46.9,-43.65,-39.25,-27.25,-26.05,-25.7,-27.7,-40.2,-47.2,-52.1,-54.65,-54,-51.35,-48.7,-41.25,-40.15,-40.1,-39.8,-44.3,-48.4,-52.4,-56.3,-57.1,-59.2,-60.6,-64.1,-67.2,-68.4,-70.85,-69.25,-66.4,-65.65,-68.15,-68.95,-68.9,-66.6,-64.25]}]},{"id":2109469360,"name":"NIBPDBP","type":"num","montype":"NIBPDBP","color":"#ffffff","unit":"mmHg","recs":[{"dt":1607071643.367762,"val":59},{"dt":1607071645.369666,"val":62}]}]}]}'

Sample Codes

curl -v -X POST https://vitaldb.net/api/send -d "data=sample_data"

<?php

// A sample PHP Script to POST data using cURL

// MUST URL-encodes the data - https://www.php.net/manual/en/function.urlencode.php

$json = "data=".urlencode($sample_data);

// Initiate new cURL

$ch = curl_init('https://vitaldb.net/api/send');

curlsetopt($ch, CURLOPTRETURNTRANSFER, true);

curlsetopt($ch, CURLINFOHEADER_OUT, true);

curlsetopt($ch, CURLOPTPOST, true);

curlsetopt($ch, CURLOPTPOSTFIELDS, $json);

curlsetopt($ch, CURLOPTSSL_VERIFYPEER, false);

curlsetopt($ch, CURLOPTSSL_VERIFYHOST, false);

// Submit the POST request

$result = curl_exec($ch);

// Print curl information

vardump(curlgetinfo($ch));

// Print response

var_dump($result);

Receive

Get array of vital sign data of designated vrcode from inputted start time to inputted end time.

Endpoint

https://vitaldb.net/api/receive

Method

GET

Parameter

Return Value

Content-Type: application/json; charset=utf-8

Content-Encoding: gzip

Gzipped JSON encoded array of data with the same format explained in the Parameter from the Send section.

Sample Codes

curl --compressed -X POST https://vitaldb.net/api/receive -H "Content-Type:application/x-www-form-urlencoded" -d

"vrcode=xxxxxxxx&bedname=xxxx&dtstart=1628831566" > output.txt

Sample code below downloads real-time data from the bed whose vrcode is ‘sample’.

Please use “pip install vitaldb” before running our sample code.

import vitaldb

if vitaldb.login(id="vitaldbtest", pw="vitaldbtest"):

res = vitaldb.receive('sample')

print(res)

Myfiles API

File List

Read file list of uploaded user files.

Endpoint

https://vitaldb.net/api/filelist

Method

GET

Parameters

Please url-encode (RFC1738) the parameters if it has any special characters.

Field	Type	Required
access_token	String	Required
bedname	String	Optional
dtstart	Unix timestamp	Optional
dtend	Unix timestamp	Optional
dtuploadstart	Unix timestamp	Optional
dtuploadend	Unix timestamp	Optional
startdate	Date	Optional
enddate	Date	Optional
uploadstartdate	Date	Optional
uploadenddate	Date	Optional

Return Value

• Content-Disposition: attachment;filename=json.gz;
• Content-Type: application/x-gzip

Sample Codes

curl -i https://vitaldb.net/api/filelist?access_token=xxxxxxxx --output json.gz

Please use “pip install vitaldb” before running our sample code.

import vitaldb

import os

import datetime

DOWNLOAD_DIR = "path/to/folder"

if not os.path.exists(DOWNLOAD_DIR):

os.mkdir(DOWNLOAD_DIR)

if vitaldb.login('ID', 'PASSWORD'):

for f in vitaldb.filelist(bedname="D1", dtstart="2010-10-01", dtend="2010-10-02")

opath = DOWNLOAD_DIR + "/" + f['filename']

if os.path.exists(opath):

continue

vitaldb.download(f['filename'], DOWNLOAD_DIR)

Track List

Get a tracklist of files

Endpoint

https://vitaldb.net/api/tracklist

Method

GET

Parameters

Please url-encode (RFC1738) the parameters if it has any special characters.

Field	Type	Required
access_token	String	Required
bedname	String	Optional
dtstart	Unix timestamp	Optional
dtend	Unix timestamp	Optional
dtuploadstart	Unix timestamp	Optional
dtuploadend	Unix timestamp	Optional
startdate	Date	Optional
enddate	Date	Optional
uploadstartdate	Date	Optional
uploadenddate	Date	Optional

Return Value

• Content-Disposition: attachment;filename=json.gz;
• Content-Type: application/x-gzip

Download

Download a vital file from the cloud.

Endpoint

https://vitaldb.net/api/download

Method

GET

Parameters

Please url-encode (RFC1738) the parameters if it has any special characters.

Return Value

Sample Codes

curl -i https://vitaldb.net/api/download?access_token=xxxxxxxx&filename=xxx.vital

Sample code below downloads a specific vital file from VitalDB to a local PC and prints the track names.

Please use “pip install vitaldb” before running our sample code.

import vitaldb

if vitaldb.login(id="vitaldbtest", pw="vitaldbtest"):

vf = vitaldb.VitalFile(vitaldb.download('TEST1211020142621.vital'))

print(vf.gettracknames())

Sample code below reads filenames from an Excel file and downloads them to a local PC.

Please use “pip install vitaldb” before running our sample code.

import vitaldb

import os

import pandas as pd

DOWNLOAD_DIR = 'path/to/folder'

if not os.path.exists(DOWNLOAD_DIR):

os.mkdir(DOWNLOAD_DIR)

df = pd.read_excel('list.xlsx')

if vitaldb.login('ID', 'PASSWORD'):

for idx, row in df.iterrows():

filename = row['filename']

opath = DOWNLOAD_DIR + '/' + filename

if os.path.exists(opath):

continue

vitaldb.download(filename, DOWNLOAD_DIR)

Upload

Upload a vital file to the VitalDB.

Endpoint

https://vitaldb.net/api/upload

Method

POST

Parameters

Please url-encode (RFC1738) the parameters if it has any special characters.

Return Value

Success