DEV Community

Cover image for Building with Fractal Bitcoin: OKX OS Integration Guide
Julian Martinez
Julian Martinez

Posted on

Building with Fractal Bitcoin: OKX OS Integration Guide

#typescript #okx #bitcoin #fractal

📌 This guide covers everything you need to integrate OKX OS Fractal Bitcoin APIs into your applications

🔗 Essential Links

📚 API Documentation

API Purpose Link
Collections Get Ordinals collection list Docs
Activities Get trade history Docs
Inscriptions Get valid inscriptions Docs

🛠️ API Endpoints

Implementation Note: These endpoints are implemented in ordinals-server.cjs, which handles request signing and authentication with the OKX API. The server acts as a proxy, adding necessary headers and signatures before forwarding requests to OKX's endpoints.

1. Get Ordinals Collections

Endpoint:

GET /api/ordinals
Enter fullscreen mode Exit fullscreen mode

Properties:

{
    "limit": "20",      // default: 20
    "slug": "string",   // optional
    "isBrc20": false    // default: false
}
Enter fullscreen mode Exit fullscreen mode

OKX Endpoint: /api/v5/mktplace/nft/fractal-ordinals/collections

2. Get Valid Inscriptions

Endpoint:

POST /api/inscriptions
Enter fullscreen mode Exit fullscreen mode

Request Body:

{
    "slug": "string",
    "walletAddress": "string",
    "limit": "10",         // default: 10
    "isBrc20": false,      // optional
    "cursor": "string",    // optional
    "sort": "string"       // optional
}
Enter fullscreen mode Exit fullscreen mode

OKX Endpoint: /api/v5/mktplace/nft/fractal-ordinals/get-valid-inscriptions

3. Get Trade History

Endpoint:

POST /api/trade-history
Enter fullscreen mode Exit fullscreen mode

Request Body:

{
    "slug": "string",
    "limit": "10",                    // default: 10
    "sort": "desc",                   // default: desc
    "isBrc20": true,                  // default: true
    "cursor": "string",               // optional
    "tradeWalletAddress": "string",   // optional
    "type": "string",                 // optional
    "orderSource": "string"           // optional
}
Enter fullscreen mode Exit fullscreen mode

OKX Endpoint: /api/v5/mktplace/nft/fractal-ordinals/trade-history

💻 Technical Stack

  • Frontend: React + TypeScript
  • Backend: Express.js
  • Security Features:
    • CORS enabled
    • CryptoJS for signing
    • Environment variables
  • API: Axios
  • Error Handling: Full logging

🚀 Getting Started

Prerequisites

Setup Steps

1.Clone repository

git clone https://github.com/Julian-dev28/ordinals-react-app-ts.git
Enter fullscreen mode Exit fullscreen mode

2.Configure environment

OKX_API_KEY=
OKX_API_SECRET=
OKX_API_PASSPHRASE=
Enter fullscreen mode Exit fullscreen mode

3.Install dependencies

npm install
Enter fullscreen mode Exit fullscreen mode

4.Start the proxy server

node ordinals-server.cjs
Enter fullscreen mode Exit fullscreen mode

5.Run the app

npm run dev
Enter fullscreen mode Exit fullscreen mode

📁 Project Structure 

./
├── ordinals-server.cjs      # Proxy API service
├── src/
│   ├── components/         
│   │   ├── OrdinalsFetcher.tsx
│   │   ├── RetrieveInscriptions.tsx
│   │   └── TradeHistory.ts
│   └── services/
│       └── okxServices.ts
Enter fullscreen mode Exit fullscreen mode

🤝 Support & Community

📝 Contributing Guidelines

  1. Fork repository
  2. Create feature branch
  3. Submit pull request

⚡ Quick Tips

  • Use environment variables for security
  • Check API response codes
  • Monitor console messages

Top comments (0)

Read next

dee_codes profile image

Setting up Redis in a Next.js Application

Hadiza Mohammed -

harshboricha98 profile image

Cloud Computing Beyond Containers: How Cloudflare’s Isolates Are Changing the Game

Harsh boricha -

harshalranjhani profile image

Setting Up a Node.js, TypeScript, and Express Project

Harshal Ranjhani -

sotergreco profile image

JavaScript - A Blessing or a Curse?

Sotiris Kourouklis -