📟Locker API

API Documentation for ApexPad Finance Token Lockers. This API provides access to information about token locks on ApexPad.

Quick Navigation

Quickly scroll to the section for each blockchain network API.

SOLANA

INJECTIVE

SEI

NEAR

FOR SOLANA

🔗 Base URL

The base URL for all API endpoints is:

https://app.apexpad.finance/sol/locker/api

Authentication

Currently, no authentication is required to access this API.

Rate Limits

There are no predefined rate limits for accessing this API.

Error Handling

In case of errors, the API will return appropriate HTTP status codes and error messages. Error responses will be in JSON format and include details about the encountered issue.

🪝Endpoints (2)

HTTP
Endpoint
Description

GET

/token-lockers

Retrieves a list of all active LP/token lock details currently on ApexPad.

GET

/lockers?mintAddress={mintAddress}

Retrieves details for a specific token locker identified by its mint address

1. Get all LP/token lockers

GET /token-lockers

Retrieves a list of all active LP/token lockers currently on ApexPad and their details

Parameters

This endpoint does not require parameters.

Example Request

GET /token-lockers
Host: app.apexpad.finance

Response

Status Code
Description
Response Body

200 (OK)

Success

An array of objects, each representing a LP/token lock. See details below.

Headers

Name
Value

Content-Type

application/json; charset=utf-8

Body

Objects
Type
Description

id

integer

Unique identifier for the token lock.

locker_pubkey

string

Public key associated with the locker.

token_pool_address

string

Pool address of the token

program_id

string

Solana program ID for the locker contract.

owner

string

Wallet address of the lock owner.

mint_address

string

Contract address of the locked token.

lock_amount

string

Total amount of tokens locked

end_time

number

Unix timestamp representing the time the lock unlocks.

locker_created_at

number

Unix timestamp representing the time the lock was created.

percentage_locked

number

Percentage of tokens locked

lock_type

string

Indicates what type of assets are locked (SPL tokens or Liquidity)

liquidity_pool_address

string

The Raydium Liquidity Pool address (will display only if its an LP Token locker)

totalRows

number

total number of rows in the token locker list

Example Response

{
  "data": [
    {
      "id": 3,
      "locker_pubkey": "CrWYcH32ZVHNqvVAsxPozt4DQcfMgQ2XQMwYYwc1CNGF",
      "token_pool_address": "GoDVBop2Z9kVMXSWVQH6J2HMMEaFUdDAK1WegcLkvMvm",
      "program_id": "AL7nyF8UR5MsmXrmnCf8SoAyT7ccK2DDQh6GZufbWcje",
      "owner": "FDrUGWsXkzR2zxkhyyT6RRhyfLd714q45JzvNbasbb27",
      "mint_address": "UD4pj9dRhRw2U25NiaA6xvR6qxQn3Hho6c27ZrUhXtt",
      "lock_amount": 0,
      "end_time": 1710260617,
      "locker_created_at": 1710259708,
      "percentage_locked": 0,
      "lock_type": "Liquidity",
      "liquidity_pool_address": "7Yo9AtDeFoXMpzUQUn4JacwkRj3oGexKhLLtaQf4X2L2"
    },
    {
      "id": 4,
      "locker_pubkey": "6vMmEXvJy8DidaP6k1tXduQEmBAigtADufg6yGS6qJSP",
      "token_pool_address": "BqxCZYfyHUkqrcaBrsPPUYPU4LWmAe1voon4pb1jpGmC",
      "program_id": "AL7nyF8UR5MsmXrmnCf8SoAyT7ccK2DDQh6GZufbWcje",
      "owner": "ERUmfHjLq5BnPDKTELyEU8mFEkaWZXMntKadDxpGik9X",
      "mint_address": "5aP8iDLqp6fF2E6vRk1eFnsWbnSinmufKEX6gY1sXPKi",
      "lock_amount": 0,
      "end_time": 1712874417,
      "locker_created_at": 1710199661,
      "percentage_locked": 0,
      "lock_type": "Liquidity",
      "liquidity_pool_address": "14k9CVBFgEEh5RyUuDgq8ByoeiUJojNjGEBS6gofWM2A"
    },
    {
      "id": 9,
      "locker_pubkey": "CKwm1KkzQYdHopgmy97oxCWE529D9zu3enqDY84uvWmy",
      "token_pool_address": "G8PeAik2sEVBWsgSSQU4g2kGsB7cTBr66kTNAaaFSigL",
      "program_id": "AL7nyF8UR5MsmXrmnCf8SoAyT7ccK2DDQh6GZufbWcje",
      "owner": "DPgyjwmbQVVHiNZKR6ysPLqJy9WWFciJLoL7tfhqQsXR",
      "mint_address": "FPS9JvA4PneRyU2K9gGwtyNbvRXEoWDxPLw8w6Hi7dPt",
      "lock_amount": 0,
      "end_time": 1713796305,
      "locker_created_at": 1710167549,
      "percentage_locked": 0,
      "lock_type": "SPL Token"
    },
    // More token lockers...
  ],
 "totalRows": 111
}

Code Snippets

JAVASCRIPT

// Get all locked LP/tokens

fetch('https://app.apexpad.finance/sol/locker/api/token-lockers')
  .then(response => response.json())
  .then(data => {
    const tokenLockers = data.data;
    console.log(tokenLockers);
  })
  .catch(error => console.error(error));

PYTHON

import requests

url = 'https://app.apexpad.finance/sol/locker/api/token-lockers'

try:
    response = requests.get(url)
    data = response.json()
    token_lockers = data['data']
    print(token_lockers)
except Exception as e:
    print("An error occurred:", e)

2. Get a specific LP/token locker

GET /lockers?mintAddress={mintAddress}

You will likely want to get details for a single locker (e.g., for your project). You can access it using this endpoint once you know its mint address.

Parameters:

Parameter
Type
Description
Required

{mintAddress}

String

Mint address of the locked token.

Yes

Example Request

GET /lockers?mintAddress={mintAddress}
Host: app.apexpad.finance

Response

Status Code
Description
Body

200 (OK)

Success

An object containing details about the requested token locker. See details below.

Headers

Name
Value

Content-Type

application/json; charset=utf-8

Body

You will get almost the same body as in the first endpoint, but this time, it's just one object containing details for the token locker with the {mintaddress} you declare and parse.

Objects
Type
Description

id

integer

Unique identifier for the token lock.

locker_pubkey

string

Public key associated with the locker.

token_pool_address

string

Pool address of the token

program_id

string

Solana program ID for the locker contract.

owner

string

Wallet address of the lock owner.

mint_address

string

Contract address of the locked token.

lock_amount

string

Total amount of tokens locked

end_time

number

Unix timestamp representing the time the lock unlocks.

locker_created_at

number

Unix timestamp representing the time the lock was created.

percentage_locked

number

Percentage of tokens locked

lock_type

string

Indicates what kind of assets are locked (SPL tokens or Liquidity)

liquidity_pool_address

string

The Raydium Liquidity Pool address (will display only if its an LP Token locker)

Example Response

Here is an example response provided that the {mintaddress} was 5aP8iDLqp6fF2E6vRk1eFnsWbnSinmufKEX6gY1sXPKi

{
  "data": [
    {
      "id": 4,
      "locker_pubkey": "6vMmEXvJy8DidaP6k1tXduQEmBAigtADufg6yGS6qJSP",
      "token_pool_address": "BqxCZYfyHUkqrcaBrsPPUYPU4LWmAe1voon4pb1jpGmC",
      "program_id": "AL7nyF8UR5MsmXrmnCf8SoAyT7ccK2DDQh6GZufbWcje",
      "owner": "ERUmfHjLq5BnPDKTELyEU8mFEkaWZXMntKadDxpGik9X",
      "mint_address": "5aP8iDLqp6fF2E6vRk1eFnsWbnSinmufKEX6gY1sXPKi",
      "lock_amount": 0,
      "end_time": 1712874417,
      "locker_created_at": 1710199661,
      "percentage_locked": 0,
      "lock_type": "Liquidity",
      "liquidity_pool_address": "14k9CVBFgEEh5RyUuDgq8ByoeiUJojNjGEBS6gofWM2A"
    }
  ]
}

Code Snippets

JAVASCRIPT

const baseUrl = "http://app.apexpad.finance/sol/locker/api";
const mintAddress = "G8CpcZVmnGPu5UBrvEeTaRX6ubcciXTmcFbEiiv2d378"; //replace with your mint address

function getSingleLocker() {
  const url = `${baseUrl}/lockers?mintAddress=${mintAddress}`;

  fetch(url)
    .then(response => {
      if (!response.ok) {
        throw new Error(`Error fetching locker details: ${response.status}`);
      }
      return response.json();
    })
    .then(data => {
      console.log("Single Token Locker Details:", data);
    })
    .catch(error => {
      console.error("Error:", error);
    });
}

getSingleLocker();

PYTHON

import requests

base_url = "http://app.apexpad.finance/sol/locker/api"
mint_address = "G8CpcZVmnGPu5UBrvEeTaRX6ubcciXTmcFbEiiv2d378" # Replace this with your mint address

def get_single_locker():
  url = f"{base_url}/lockers?mintAddress={mint_address}"

  try:
    response = requests.get(url)
    response.raise_for_status()  # Raise exception for non-200 status codes
    data = response.json()
    print("Token Locker Details:", data)
  except requests.exceptions.RequestException as error:
    print("Error:", error)

get_single_locker()

FOR INJECTIVE

Documentation will be available soon

FOR SEI NETWORK

Documentation will be available soon

FOR NEAR PROTOCOL

Documentation will be available soon

PreviousAudits and SecurityNextFrequently Asked Questions

Last updated