Info

Property token detail pages: header, overview, public documents, and password-gated private documents.

Endpoints

Method	Path	Description
`GET`	`/api/info/:tokenName/header`	Property header
`GET`	`/api/info/:tokenName/overview`	Property overview
`GET`	`/api/info/:tokenName/documents`	Public documents
`GET`	`/api/info/:tokenName/documents/private/:password`	Private documents

Property header

GET /api/info/:tokenName/header

Returns header metadata for a property token page.

Request


import axios from 'axios';
 
const response = await axios.get('https://api.loafmarkets.com/api/info/:tokenName/header', {
});
 
console.log(response.data);

Parameters

Parameter	Type	Required	Description
`tokenName`	`string`	Yes	(path) Lowercase property token symbol.

Response


// See @loafmarkets/shared-types for the response type
type Response = Record<string, unknown>;

Example response:


{
  "success": true
}

Errors

Status	Code	Description
`400`	`validation_error`	Request failed schema validation.
`401`	`unauthorized`	Missing or invalid authentication.
`404`	`not_found`	Resource not found (where applicable).
`500`	`internal_error`	Unexpected server error.

Property overview

GET /api/info/:tokenName/overview

Returns overview content for a property token.

Request


import axios from 'axios';
 
const response = await axios.get('https://api.loafmarkets.com/api/info/:tokenName/overview', {
});
 
console.log(response.data);

Parameters

Parameter	Type	Required	Description
`tokenName`	`string`	Yes	(path) Lowercase property token symbol.

Response


// See @loafmarkets/shared-types for the response type
type Response = Record<string, unknown>;

Example response:


{
  "success": true
}

Errors

Status	Code	Description
`400`	`validation_error`	Request failed schema validation.
`401`	`unauthorized`	Missing or invalid authentication.
`404`	`not_found`	Resource not found (where applicable).
`500`	`internal_error`	Unexpected server error.

Public documents

GET /api/info/:tokenName/documents

Returns publicly available property documents.

Request


import axios from 'axios';
 
const response = await axios.get('https://api.loafmarkets.com/api/info/:tokenName/documents', {
});
 
console.log(response.data);

Parameters

Parameter	Type	Required	Description
`tokenName`	`string`	Yes	(path) Lowercase property token symbol.

Response


// See @loafmarkets/shared-types for the response type
type Response = Record<string, unknown>;

Example response:


{
  "success": true
}

Errors

Status	Code	Description
`400`	`validation_error`	Request failed schema validation.
`401`	`unauthorized`	Missing or invalid authentication.
`404`	`not_found`	Resource not found (where applicable).
`500`	`internal_error`	Unexpected server error.

Private documents

GET /api/info/:tokenName/documents/private/:password

Returns private documents when the correct password is supplied.

Request


import axios from 'axios';
 
const response = await axios.get('https://api.loafmarkets.com/api/info/:tokenName/documents/private/:password', {
});
 
console.log(response.data);

Parameters

Parameter	Type	Required	Description
`tokenName`	`string`	Yes	(path) Lowercase property token symbol.
`password`	`string`	Yes	(path) Document access password.
`lang`	`'en' \| 'cn'`	No	(query) Document language. Default: `en`.

Response


// See @loafmarkets/shared-types for the response type
type Response = Record<string, unknown>;

Example response:


{
  "success": true
}

Errors

Status	Code	Description
`400`	`validation_error`	Request failed schema validation.
`401`	`unauthorized`	Missing or invalid authentication.
`404`	`not_found`	Resource not found (where applicable).
`500`	`internal_error`	Unexpected server error.