Endpoints Overview

DePINscan currently provides the following API endpoints:

This endpoint is used for uploading device identifiers and their associated longitude and latitude.

POST/api/upload-device-metrics

Header parameters

Body

application/json

uid*string

user id

events*array of object

events

Response

200400

Upload successfully.

Body

application/json

message*string

message

Request

JavaScriptCurlPython

const response = await fetch('/api/upload-device-metrics', {
    method: 'POST',
    headers: {
      "version": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "uid": "text",
      "events": [
        {
          "publisher": "text",
          "custom": {
            "longitude": 0,
            "latitude": 0
          }
        }
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "message": "text"
}

This endpoint is used for getting project publishers by project id.

GET/api/project/{uid}/publishers

Path parameters

uid*string

Project Id

Response

200400

Get project publishers successfully.

Body

application/json

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/api/project/{uid}/publishers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  "text"
]

Delete all devices by project id.

DELETE/api/delete-all-devices

Body

application/json

uid*string

uid

Response

200400

Delete all devices successfully.

Body

application/json

message*string

message

Request

JavaScriptCurlPython

const response = await fetch('/api/delete-all-devices', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "uid": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "message": "text"
}

Please use the DELETE method with caution, as it currently deletes ALL devices from your project. This action is not reversible!