PUT Request

📘

PUT Request on Presigned URL

Once the job is successfully created, upload the payload using HTTP PUT method on generated presigned url. Read More

JSON Payload

This API accepts payload in following two formats:

Tradebook

View Workbook

👍

Click here to learn more about this JSON Payload

{
	"@entity": "workbook",
	"name": "tradebook_workbook",
  "metadata": {
    "currency": "INR"
  },
	"sheets": [
		{
			"@entity": "sheet",
			"name": "stock_tradebook_sheet",
			"blocks": [
				{
					"@entity": "table",
					"name": "stock_tradebook_table",
					"header": ["isin", "trade_id", "symbol", "quantity", "date", "price", "transaction_type", "transfer_expenses", "label", "product_type"],
					"rows": []
				},
				{
					"@entity": "table",
					"name": "reference_data_table",
					"header": ["isin", "symbol", "address", "country", "zip_code", "52_week_high", "closing_value"],
					"rows": []
				},
				{
					"@entity": "table",
					"name": "dividend_table",
					"header": ["isin", "symbol", "quantity", "date", "dividend_amount", "tax_withheld"],
					"rows": []
				}
			]
		},
		{
			"@entity": "sheet",
			"name": "adr_tradebook_sheet",
			"blocks": [
				{
					"@entity": "table",
					"name": "adr_tradebook_table",
					"header": ["isin", "trade_id", "symbol", "quantity", "date", "price", "transaction_type", "transfer_expenses", "label", "product_type"],
					"rows": []
				},
				{
					"@entity": "table",
					"name": "reference_data_table",
					"header": ["isin", "symbol", "address", "country", "zip_code", "52_week_high", "closing_value"],
					"rows": []
				},
				{
					"@entity": "table",
					"name": "dividend_table",
					"header": ["isin", "symbol", "quantity", "date", "dividend_amount", "tax_withheld"],
					"rows": []
				}
			]
		},
		{
			"@entity": "sheet",
			"name": "mutual_fund_tradebook_",
			"blocks": [
				{
					"@entity": "table",
					"name": "mutual_fund_tradebook_table",
					"header": ["isin", "trade_id", "symbol", "quantity", "date", "price", "transaction_type", "transfer_expenses", "label", "product_type"],
					"rows": []
				},
				{
					"@entity": "table",
					"name": "reference_data_table",
					"header": ["isin", "symbol", "address", "country", "zip_code", "52_week_high", "closing_value"],
					"rows": []
				},
				{
					"@entity": "table",
					"name": "dividend_table",
					"header": ["isin", "symbol", "quantity", "date", "dividend_amount", "tax_withheld"],
					"rows": []
				}
			]
		},
		{
			"@entity": "sheet",
			"name": "etf_tradebook_sheet",
			"blocks": [
				{
					"@entity": "table",
					"name": "etf_tradebook_table",
					"header": ["isin", "trade_id", "symbol", "quantity", "date", "price", "transaction_type", "transfer_expenses", "label", "product_type"],
					"rows": []
				},
				{
					"@entity": "table",
					"name": "reference_data_table",
					"header": ["isin", "symbol", "address", "country", "zip_code", "52_week_high", "closing_value"],
					"rows": []
				},
				{
					"@entity": "table",
					"name": "dividend_table",
					"header": ["isin", "symbol", "quantity", "date", "dividend_amount", "tax_withheld"],
					"rows": []
				}
			]
		},
		{
			"@entity": "sheet",
			"name": "interest_income_sheet",
			"blocks": [
				{
					"@entity": "table",
					"name": "interest_income_table",
					"header": ["description", "date", "amount", "tax_withheld"],
					"rows": []
				}
			]
		},
		{
			"@entity": "sheet",
			"name": "client_details_sheet",
			"blocks": [
				{
					"@entity": "list",
					"name": "client_details_list",
					"items": [
						["name", ""],
						["pan", ""],
						["client_id", ""]
					]
				},
				{
					"@entity": "table",
					"name": "client_tin_table",
					"header": ["country", "tin"],
					"rows": []
				}
			]
		}
	]
}

Tradewise PnL

View Workbook

👍

Click here to learn more about this JSON Payload

{
    "@entity": "workbook",
    "name": "workbook",
    "sheets": [
        {
            "@entity": "sheet",
            "name": "client_details_sheet",
            "blocks": [
                {
                    "@entity": "table",
                    "name": "client_tin_table",
                    "header": [
                        "name"
                    ],
                    "rows": [
                        [
                            "pan"
                        ],
                        [
                            "client_id"
                        ]
                    ]
                }
            ]
        },
        {
            "@entity": "sheet",
            "name": "stock_tradewise_settlement_sheet",
            "blocks": [
                {
                    "@entity": "table",
                    "name": "stock_tradewise_settlement_table",
                    "header": [
                        "isin",
                        "symbol",
                        "quantity",
                        "date",
                        "dividend_amount",
                        "currency",
                        "tax_withheld"
                    ],
                    "rows": [
                        [
                            "stock_tradewise_holding_table"
                        ],
                        [
                            "isin",
                            "symbol",
                            "quantity",
                            "buy_date",
                            "buy_price",
                            "currency",
                            "transaction_type",
                            "label",
                            "last_traded_price"
                        ],
                        [
                            "stock_tradewise_open_sell_table"
                        ],
                        [
                            "isin",
                            "symbol",
                            "quantity",
                            "sell_date",
                            "sell_price",
                            "currency",
                            "transaction_type",
                            "label",
                            "last_traded_price"
                        ]
                    ]
                }
            ]
        },
        {
            "@entity": "sheet",
            "name": "adr_tradewise_settlement_sheet",
            "blocks": [
                {
                    "@entity": "table",
                    "name": "adr_tradewise_settlement_table",
                    "header": [
                        "isin",
                        "symbol",
                        "quantity",
                        "date",
                        "dividend_amount",
                        "currency",
                        "tax_withheld"
                    ],
                    "rows": [
                        [
                            "adr_tradewise_holding_table"
                        ],
                        [
                            "isin",
                            "symbol",
                            "quantity",
                            "buy_date",
                            "buy_price",
                            "currency",
                            "transaction_type",
                            "label",
                            "last_traded_price"
                        ],
                        [
                            "adr_tradewise_open_sell_table"
                        ],
                        [
                            "isin",
                            "symbol",
                            "quantity",
                            "sell_date",
                            "sell_price",
                            "currency",
                            "transaction_type",
                            "label",
                            "last_traded_price"
                        ]
                    ]
                }
            ]
        },
        {
            "@entity": "sheet",
            "name": "mutual_fund_tradewise_settlemen",
            "blocks": [
                {
                    "@entity": "table",
                    "name": "mutual_fund_tradewise_settlement_table",
                    "header": [
                        "isin",
                        "symbol",
                        "quantity",
                        "date",
                        "dividend_amount",
                        "currency",
                        "tax_withheld"
                    ],
                    "rows": [
                        [
                            "mutual_fund_tradewise_holding_table"
                        ],
                        [
                            "isin",
                            "scheme_name",
                            "scheme_type",
                            "quantity",
                            "buy_date",
                            "buy_price",
                            "currency",
                            "transaction_type",
                            "label",
                            "last_traded_price"
                        ]
                    ]
                }
            ]
        },
        {
            "@entity": "sheet",
            "name": "etf_tradewise_settlement_sheet",
            "blocks": [
                {
                    "@entity": "table",
                    "name": "etf_tradewise_settlement_table",
                    "header": [
                        "isin",
                        "symbol",
                        "quantity",
                        "date",
                        "dividend_amount",
                        "currency",
                        "tax_withheld"
                    ],
                    "rows": [
                        [
                            "etf_tradewise_holding_table"
                        ],
                        [
                            "isin",
                            "scheme_name",
                            "scheme_type",
                            "quantity",
                            "buy_date",
                            "buy_price",
                            "currency",
                            "transaction_type",
                            "label",
                            "last_traded_price"
                        ],
                        [
                            "etf_tradewise_open_sell_table"
                        ],
                        [
                            "isin",
                            "scheme_name",
                            "scheme_type",
                            "quantity",
                            "sell_date",
                            "sell_price",
                            "currency",
                            "transaction_type",
                            "label",
                            "last_traded_price"
                        ]
                    ]
                }
            ]
        },
        {
            "@entity": "sheet",
            "name": "interest_income_sheet",
            "blocks": [
                {
                    "@entity": "table",
                    "name": "__EMPTY",
                    "header": [
                        "interest_income_table"
                    ],
                    "rows": [
                        [
                            "description",
                            "date",
                            "amount",
                            "currency",
                            "tax_witheld"
                        ]
                    ]
                }
            ]
        }
    ]
}