Skip to content

REST API V3 Payload Overview

OMS V3

Nubra's most powerful OMS is here with REST API V3. This documentation covers authentication, market data, trading, portfolio, and realtime order workflows using the current V3 request and response payloads.

Use the PROD base URL https://api.nubra.io for live production usage and the UAT base URL https://uatapi.nubra.io for sandbox testing.

Nubra's REST API provides a fast, secure, and scalable interface for developers building trading systems, backend services, execution engines, or enterprise-grade market-data pipelines. It exposes low-latency HTTP endpoints that allow complete programmatic access to Nubra's trading infrastructure.

The REST API is designed for reliability, consistency, and performance - enabling you to build anything from automated trading strategies to large-scale institutional systems.

What's New In V3

This V3 track is intended for developers building with the current OMS V3 REST API.

This documentation set focuses on:

  • the current V3 trading payload structure
  • a cleaner and more unified OMS flow
  • the V3 REST authentication header style using Authorization and x-device-id
  • request and response patterns for OMS V3 endpoints
  • clear setup guidance for production and sandbox usage
  • endpoint-level examples for trading, portfolio, and realtime order workflows

Key Sections

If you are getting started, start with these pages first:

  1. Authentication
  2. Static IP Validation
  3. Orders Overview
  4. Place Order
  5. Place Multi Order
  6. Place Strategy Order
  7. Get Order Margin
  8. Realtime Order Updates

Quick Start

For a new REST API V3 integration, use this order:

  1. Complete Authentication using the environment you are integrating with: PROD for live usage or UAT for sandbox testing.
  2. Call Static IP Validation if static IP access is enabled for the account.
  3. Use Get Instruments to resolve the ref_id and exchange metadata needed by the V3 payloads.
  4. Read Orders Overview to understand the V3 request model and intent-order flow.
  5. Run one primary placement flow using Place Order or Place Strategy Order, depending on your integration.
  6. Use Get Order Margin and Realtime Order Updates to complete your order workflow.

Key Features

  • REST-like resource-based endpoints using standard HTTP verbs
  • Low-latency order execution for regular, CO, flexi, and basket orders
  • Comprehensive market data access including quotes, Greeks, and historical data
  • Portfolio & account data including positions, holdings, and available funds
  • Secure MPIN-based authentication for all critical operations
  • Consistent JSON request/response format for seamless integration
  • Language-agnostic - works with Python, JavaScript, Go, Rust, Java, C#, and more

Who Is This API For?

The REST API is ideal for:

  • Backend and server-side systems
  • Execution engines and OMS/RMS infrastructure
  • Institutional and proprietary trading desks
  • Traders who prefer raw HTTP APIs over SDK abstractions
  • Developers integrating Nubra into multi-language codebases

If you need maximum control, custom orchestration, or advanced system-to-system automation, the REST API is the right tool.

Authentication Model

All REST requests require:

  1. API Key (client_id)
  2. MPIN-based session (MPIN -> session token)

Once authenticated, you can generate session tokens and call any trading or market-data endpoint.

Authentication flow:

  1. Login using user ID
  2. Submit MPIN securely
  3. Receive an encrypted session token
  4. Use the session token for all API requests in the Authorization header

Detailed endpoints are available in the Authentication section.

Market Data

Using the REST API, you can retrieve:

  • Live market quotes
  • Greeks and option chain snapshots
  • Historical candles (OHLCV)
  • Order book data
  • Intraday and multi-day timeframes

Market-data responses follow a consistent JSON structure designed for speed and easy parsing.

Trading

The REST API supports:

  • Placing new orders (all varieties)
  • Modifying price/quantity
  • Cancelling pending orders
  • Basket and multi-leg execution
  • Fetching complete order book and trade book

All trading operations are checked and protected with session-level security.

Portfolio & Funds

REST endpoints also expose:

  • Current positions
  • Holding breakup with average buy price
  • Fund availability
  • Margin details
  • P&L data

These endpoints allow complete portfolio lifecycle management for both live and automated trading.

Rate Limits & Best Practices

To ensure stability and fair usage:

  • All endpoints follow defined rate limits
  • Burst traffic is handled gracefully
  • Clients should cache non-live data where possible
  • Long-running strategies should refresh tokens proactively

Details are documented alongside each endpoint group.

Getting Started

To begin using the REST API:

  1. Generate API credentials
  2. Authenticate using your MPIN
  3. Create a session token
  4. Start making HTTP requests to trading or data endpoints

Sample request/response payloads are included in each endpoint's documentation.

Support

If you require help, guidance, or have questions about integration, feel free to contact:

support@nubra.io

Our team will be happy to assist you with API onboarding and usage.

NEO Assistant