https://github.com/riyavsinha/synapse-node-api
Unofficial NodeJS API client for Sage Bionetwork's Synapse service
https://github.com/riyavsinha/synapse-node-api
Last synced: 11 months ago
JSON representation
Unofficial NodeJS API client for Sage Bionetwork's Synapse service
- Host: GitHub
- URL: https://github.com/riyavsinha/synapse-node-api
- Owner: riyavsinha
- License: mit
- Created: 2023-08-24T19:13:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-17T00:34:03.000Z (almost 3 years ago)
- Last Synced: 2025-08-09T16:56:53.150Z (12 months ago)
- Language: TypeScript
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# synapse-node-api
This is an unofficial API client for Sage Bionetwork's Synapse service. It is
extremely limited in scope currently. Help is welcome to incrementally expand it.
## Usage
### Prerequisites
You must have a Synapse account and have created a Personal Access Token (PAT). It is recommended that you place this in a `.env` file to keep this secure.
## Installation
```
npm install synapse-node-api
```
### Initialization
```
import SynapseClient from 'synapse-node-api';
const synapse = new SynapseClient();
// Example: getting all subdirectories of an entity
synapse.entity.children({parentId: 'syn123456', includeTypes: ['folder']})
```
## Supported Endpoints
- Entity:
- List Children
- Get Child
- File:
- Read contents
- Search