Vorliq Docs

Developer Examples

Practical read-oriented examples for building with the stable v1 API and SDK. Never put a real private key into frontend source code; signing should happen only in a user-controlled local wallet or local SDK environment.

Check Network Status

curl https://vorliq.org/api/v1/health
curl https://vorliq.org/api/v1/network/manifest

Create a Payment URL

const VorliqSDK = require("vorliq-sdk");
const sdk = new VorliqSDK();
const url = sdk.createPaymentURL("3MNQE1X7T4Bz9kLmNpQrStUvWx", 2.5);

Check Balance

curl "https://vorliq.org/api/v1/wallet/balance?address=3MNQE1X7T4Bz9kLmNpQrStUvWx"

View Latest Blocks

curl "https://vorliq.org/api/v1/chain/blocks?limit=5&offset=0"

Verify Audit Manifest

curl https://vorliq.org/api/v1/audit/manifest
node tools/verify_audit.js https://vorliq.org

Optional Analytics Event

curl -X POST https://vorliq.org/api/v1/analytics/event \
  -H "Content-Type: application/json" \
  -d "{\"event_type\":\"page_view\",\"route\":\"/docs\",\"category\":\"docs\",\"anonymous_session_id\":\"anon_example1234567890\"}"

Analytics events are optional, aggregate-oriented, and must not include private keys, passwords, admin tokens, raw IP addresses, raw user agents, or message bodies.

Use SDK with v1 API

const VorliqSDK = require("vorliq-sdk");
const sdk = new VorliqSDK({ nodeUrl: "https://vorliq.org", apiVersion: "v1" });
sdk.setRequestId("docs-example-1");
const version = await sdk.getAPIVersion();
const summary = await sdk.getChainSummary();

Local-Only Signing Placeholder

await sdk.sendTransaction(
  "SENDER_ADDRESS",
  "-----BEGIN EC PRIVATE KEY-----\\nFAKE_LOCAL_ONLY_EXAMPLE\\n-----END EC PRIVATE KEY-----",
  "-----BEGIN PUBLIC KEY-----\\nFAKE_PUBLIC_KEY\\n-----END PUBLIC KEY-----",
  "RECEIVER_ADDRESS",
  1
);

The private key above is deliberately fake. Do not expose real private keys in app code, logs, docs, analytics, bug reports, or backend requests.