Contact UsSupportSignup

Job Status

Suggest Edits

API Pricing

Overview

API takes job_id and gives back job status and url URL to download the generated tax P&L.

Problem

Solution

  • API that provides the status of Tax P&L calculation.
  • Upon successful completion, you will be provided with a url to download the output file.

Endpoint

HTTP MethodEndpoint
GET/it/calculator/securities/foreign/tax-pnl

API Endpoint  Contact Us  Free Trial

Request

Query Parameters

ParamTypeDescriptionExample
job_idstringJob ID from previously generate request49f15670-1516-4e4f-9821-9dff154d3154

Sample CURL Request

curl --location 'http://api.sandbox.co.in/it/calculator/securities/foreign/tax-pnl?job_id=49f15670-1516-4e4f-9821-9dff154d3154' \
--header 'Authorization: xxxxxxxxxxxxxx' \
--header 'x-api-version: 1.0.0' \
--header 'x-api-key: xxxxxxxxxxxxxx' \
--header 'Content-Type: application/json'

❗️

Test Environment Not Available

Response

ParamTypeDescriptionExample
transaction_idstringAPI Transaction ID7d0e9b77-a112-49a9-a204-0eec00205d78
codenumberHTTP response status code200
urlstringLink from where you can download the generated outputhttps://....
statusstringJob Status. Possible Values:
created
queued
in_progress
succeeded
failed		in_progress
timestampstringTimestamp of the request1691486144000

Sample Generated output

The generated output (depending upon the input and output modes can be seen in the individual requests)

Sample Response

This is an asynchronous API. The API responds back a signed S3 URL which you can use to fetch the output data.

{
    "transaction_id": "7d0e9b77-a112-49a9-a204-0eec00205d78",
    "code": 200,
    "data": {
        "status": "created"
    },
    "timestamp": 1691486144000
}

{
    "transaction_id": "7d0e9b77-a112-49a9-a204-0eec00205d78",
    "code": 200,
    "data": {
        "status": "queued"
    },
    "timestamp": 1691486144000
}

{
    "transaction_id": "7d0e9b77-a112-49a9-a204-0eec00205d78",
    "code": 200,
    "data": {
        "status": "in_progress"
    },
    "timestamp": 1691486144000
}

{
    "transaction_id": "7d0e9b77-a112-49a9-a204-0eec00205d78",
    "code": 200,
    "data": {
        "url": "https://s3.ap-south-1.amazonaws.com/in-co-sandbox-it-tax-pnl-computation-dev/49f15670-1516-4e4f-9821-9dff154d3154.output?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCmFwLXNvdXRoLTEiRzBFAiAtZgVlemk1AHQryNnG3IMaAQUIlQaBV1AFTU2jWDyoEAIhAM36EduLVfUzxkqlABo5m3H3zbmfAYYLncp74Lg2wE9nKpUDCIr%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMMDcyNzU1MzM1OTc4IgwHmtwaDnulLeLMy78q6QLz1ZGqr4zLcN4NGgPRswrnNug8srRtGGluWrJpoLO3MDV9Xzzk7z5bScCgzZHEaZxvCIMy6rH0sYEE8oDudPF2N7i0m7psTRAPYGDAz5i0mJi8N42JXrQSv4Aw%2BmbFs3%2FFVKoQzLOGErFv6%2BUDE8JA02fl7UQVyvDVJGLHGoed5wiQ2rrFp3qYoJdTvGSw4n2ymramBkE1NfrxH5P2DefvF9MpxpA6nHRsfKpzMjqfKh9O%2BCY2E07fPP8hn%2BkrWVuBFZWUdwT%2BLLcHGW5HsMPNZmqiRwSsDNhkGXtozt8HtydFcRWG%2B7ztijYItAxSrZrusv%2BmI1Oaverp1aXRViwsnBw1Qaeq2EilS6jkn0MX5d4nlYMcJ%2F0Ta3ros4fecY7Kyr7XYu3TnY%2FhnTxEBgU1SLW1MOJFh4Zzw6WQCtmTOw7a1X7wSLjjOIn7CLiYzkLsRGnTTdUVvN6csKqecN8mP9YFxrTeeiA3MMGPyKYGOp0By2viFjHJfVOWMO4r%2BV83y3ExgYl4FpHNkr1gwkYb77EWfxvtZdAp8WT0nFvTIP8asqtKiJSA5MLMk2l%2F59CI1bLg4y6Yudf6roDqDHtlMaKUEiP%2BUj4SZ6lDNcuUwFDX6e8fETm81BjpaJbbJMjkV6ELZz53IOIH9gEDxJCXDlhYyBxKzonD6Pzq4IgDYewsYAj0FVRcQsswSaifew%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230808T091558Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604795&X-Amz-Credential=ASIARB4EOKMVNYO3L7UO%2F20230808%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=4504a7a7cefaf41037637f4c50a85976fc2ffbd4f391778af59edf62faf1f35d",
        "status": "succeeded"
    },
    "timestamp": 1691486144000
}

{
    "transaction_id": "7d0e9b77-a112-49a9-a204-0eec00205d78",
    "code": 200,
    "data": {
        "status": "failed"
    },
    "timestamp": 1691486144000
}

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charge

Since the Tax P&L Calculator from Tradebook API is not a Paid API, no wallet charge will take place.

Versioning

This API is currently in major version 1.0. Refer to our versioning policies here

Updated about 1 month ago