Skip to content

REST API V3 Payload Overview

UAT V3 New

Our new powerful OMS is coming soon, and as part of this transition we are providing UAT V3 access to help you test early and migrate with confidence. Use these REST API V3 pages to validate the newer trading payload structure and endpoint flow for your strategies and integrations.

These pages are intended for UAT V3 validation. If you are not testing V3 yet, you can continue using the main REST API documentation. The current V2 OMS endpoints will be deprecated, so it is advised to start validating the UAT V3 endpoints as early as possible.

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 clients validating the upgraded UAT rollout.

Compared with the current public REST track, this documentation set focuses on:

  • the newer V3 trading payload structure
  • a cleaner and more unified OMS flow
  • the UAT header contract aligned to x-app-version: 0.4.5 or above
  • updated request patterns for the upgraded UAT setup
  • clearer onboarding guidance for teams validating the new UAT flow
  • a transition path that still allows current users to remain on the existing public track until they are ready

Majorly Updated Sections

If you are evaluating the V3 rollout, start with these pages first:

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

Migration Quick Start

If you are currently using the public REST API track, use this order to start validating the upgraded UAT V3 flow:

  1. Complete Authentication against the upgraded UAT environment.
  2. Use Get Instruments to resolve the ref_id and exchange metadata needed by the V3 payloads.
  3. Read Orders Overview to understand the V3 request model and intent-order flow.
  4. Validate one primary placement flow using Place Order or Place Strategy Order, depending on your integration.
  5. Use Get Order Margin and Realtime Order Updates to complete your UAT verification path.

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 validated 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