getLocus RPC

The getLocus RPC is using an HTTP layer to send data over Internet. You can send GET or POST request to https://getlocus.io/rpc/v1/:module/:method, where :module is the module name and the :method is the method name.

List of available modules:

• item create, edit and remove space items.
• space manage spaces.

The fist parameter of module method can be sent in POST request body. Accepted format is application/json.

The server will respond with 200 status code and the result of method or error.

All responses are formatted as JSON strings. The result of a method call will match the declared in documentation. An error response has next fields:

• code - error code.
• err - error message.

Example of GET request

This example calls space list method without argument.

GET /rpc/v1/space/list
Authorization: Bearer AUTH_TOKEN
Copy

Example of POST request

This example calls space edit method and edit space size.

POST /rpc/v1/space/edit
Authorization: Bearer AUTH_TOKEN
Content-Type: application/json

{"id":"123456789012345","edit":{"size":1}}
Copy

node.js

We provide a npm package, which includes types for typescript, compatible with modern browsers and node.js 20+.

Installation:

npm install getlocus-rpc
Copy

Usage:

import {getLocus} from 'getlocus-rpc';

async function run() {
  const gl = new GetLocus({token: '<AUTH_TOKEN>'});

  const spaces = await gl.space.list();

  for (const s of spaces) {
      const items = gl.item.list({spaceId: s.id});
      
      console.log(items);
  }
}
Copy

Deprecated warning

Please don't use deprecated stuff in new projects. Deprecations are related to upcoming update of client getLocus 2.0. We plan a big update this year. All changes are related to items in spaces.