Introduction
Built for finance teams and their systems
The Clarion API gives your systems the same data you see in Clarion: every reconciled airline line, the airline invoices and credit notes behind them, and TraCarta's reconciliation reports.
It's read-only and safe by design. A key acts as the person who made it and sees exactly what they can see: the same companies, GSTINs and columns. Nothing more.
https://clarion.tracarta.com/api/v1/gstinsCompanies and GSTINsGET/linesReconciled linesGET/documents/{id}Airline PDFGET/reportsReconciliation reportsGET/reports/{id}Download a reportQuick start
Three steps to your first call
- 1Make a keyIn Clarion, open Settings → API and choose Create key. Copy it straight away: it's shown only once.
- 2Keep it safeStore it as an environment variable, for example
CLARION_KEY. Never put it in a web page or share it by email. - 3Call the APIStart with
/gstinsto check the key works, then fetch your lines.
curl "https://clarion.tracarta.com/api/v1/gstins" \
-H "Authorization: Bearer $CLARION_KEY"Authentication
One key, sent with every request
Send your key in the Authorization header as a Bearer token. Keys start with clr_live_.
- Keys can only read. Nothing in the API changes your data.
- A key sees at most what its owner sees: their companies, GSTINs and the columns TraCarta allows.
- When you make a key you choose what it can read (data lines, documents, reports, GSTINs), which addresses it works from, and when it stops working.
- If the owner loses access to a company, so does the key, immediately.
- Revoke a key any time in Settings → API; it stops working straight away.
Authorization: Bearer clr_live_8f2a…{
"error": "This key isn't valid or has been turned off."
}Endpoint
Companies and GSTINs
/api/v1/gstinsThe companies and GSTINs your key can see. A good first call to check the key works.
curl "https://clarion.tracarta.com/api/v1/gstins" \
-H "Authorization: Bearer $CLARION_KEY"{
"account": "Vertex Global Services",
"companies": [
{
"name": "Vertex Analytics India Pvt Ltd",
"pan": "AAKCV4821M",
"gstins": [
{
"gstin": "29AAKCV4821M1Z5",
"state": "Karnataka"
},
{
"gstin": "27AAKCV4821M1ZA",
"state": "Maharashtra"
}
]
},
{
"name": "Vertex Technologies Pvt Ltd",
"pan": "AAGCV1190K",
"gstins": [
{
"gstin": "33AAGCV1190K1Z0",
"state": "Tamil Nadu"
}
]
}
]
}Endpoint
Reconciled lines
/api/v1/linesEvery reconciled line, the same as My Data, newest airline invoice date first. Each line has the columns TraCarta lets your company see, plus links to its airline PDF.
- All the filters below work here.
- in_gstr2b is true, false, or null when not checked yet (accounts with reconciliation).
Query parameters
fytext2026-27gstintext, repeatable27AAKCV4821M1ZAfrom · todate2026-10-01monthYYYY-MM, repeatable2026-10airlinetext, repeatableIndiGotypeinvoice · creditdoclinked · waitingb2yes · no · uncheckedqtextpagenumber1per_pagenumber500curl "https://clarion.tracarta.com/api/v1/lines?fy=2026-27&airline=IndiGo&doc=linked&per_page=2" \
-H "Authorization: Bearer $CLARION_KEY"{
"total": 112,
"page": 1,
"per_page": 2,
"lines": [
{
"transaction_id": "VX-B98491",
"financial_year": "2026-27",
"transaction_type": "Invoice",
"client_gstn": "27AAKCV4821M1ZA",
"pax_name": "Ms Kavya Raman",
"itinerary": "DEL-BOM",
"airline_iata": "6E",
"airline_name": "IndiGo",
"airline_invoice_number": "MH12261028BA9849",
"airline_invoice_date": "2026-10-28",
"airline_gstn": "27AABCI2726B1Z6",
"taxable_value": 13142,
"total_igst": 0,
"total_cgst": 328.55,
"total_sgst": 328.55,
"gstr2b_status": "Yes",
"in_gstr2b": true,
"document_url": "https://clarion.tracarta.com/api/v1/documents/7f3c…"
},
{
"transaction_id": "VX-B1027827",
"financial_year": "2026-27",
"transaction_type": "Invoice",
"client_gstn": "29AAKCV4821M1Z5",
"pax_name": "Ms Pooja Shetty",
"itinerary": "BOM-BLR",
"airline_iata": "6E",
"airline_name": "IndiGo",
"airline_invoice_number": "DL12261028BA10278",
"airline_invoice_date": "2026-10-28",
"airline_gstn": "07AABCI2726B1Z6",
"taxable_value": 6468,
"total_igst": 323.4,
"total_cgst": 0,
"total_sgst": 0,
"gstr2b_status": null,
"in_gstr2b": null,
"document_url": "https://clarion.tracarta.com/api/v1/documents/a91d…"
}
]
}Endpoint
Airline PDF
/api/v1/documents/{id}Downloads the airline invoice, credit note or debit note for a line. Use the document_url from /lines; the file name is the document number.
curl "https://clarion.tracarta.com/api/v1/documents/DOCUMENT_ID" \
-H "Authorization: Bearer $CLARION_KEY" \
-o invoice.pdf(the PDF file)Endpoint
Reconciliation reports
/api/v1/reportsThe reconciliation reports TraCarta has added, newest first, with the period each one covers. Filter with fy.
Query parameters
fytext2026-27curl "https://clarion.tracarta.com/api/v1/reports?fy=2026-27" \
-H "Authorization: Bearer $CLARION_KEY"{
"total": 2,
"reports": [
{
"id": "3b1e…",
"name": "Reconciliation – Oct 2026",
"period": "Oct 2026",
"period_from": "2026-10-01",
"period_to": "2026-10-31",
"financial_year": "2026-27",
"added_on": "2026-11-11T09:30:00.000Z",
"size_bytes": 16384,
"download_url": "https://clarion.tracarta.com/api/v1/reports/3b1e…"
},
{
"id": "c720…",
"name": "Quarterly summary – Q1 FY 2026-27",
"period": "Q1 FY 2026-27 (Apr–Jun 2026)",
"period_from": "2026-04-01",
"period_to": "2026-06-30",
"financial_year": "2026-27",
"added_on": "2026-10-11T09:30:00.000Z",
"size_bytes": 29696,
"download_url": "https://clarion.tracarta.com/api/v1/reports/c720…"
}
]
}Endpoint
Download a report
/api/v1/reports/{id}Downloads one reconciliation report as the Excel workbook TraCarta uploaded.
curl "https://clarion.tracarta.com/api/v1/reports/REPORT_ID" \
-H "Authorization: Bearer $CLARION_KEY" \
-o report.xlsx(the Excel file)Reference
Filters
Use these on /lines. Combine as many as you like. Repeat a parameter to pass several values, for example airline=IndiGo&airline=Air India.
fytext2026-27gstintext, repeatable27AAKCV4821M1ZAfrom · todate2026-10-01monthYYYY-MM, repeatable2026-10airlinetext, repeatableIndiGotypeinvoice · creditdoclinked · waitingb2yes · no · uncheckedqtextpagenumber1per_pagenumber500Reference
Pagination
Lines come in pages: 100 by default, up to 1,000 with per_page. Every response says how many lines match in total, so you know when you have them all.
totalpageper_pageimport os, requests
key = os.environ["CLARION_KEY"]
lines, page = [], 1
while True:
r = requests.get(
"https://clarion.tracarta.com/api/v1/lines",
params={"fy": "2026-27", "per_page": 1000, "page": page},
headers={"Authorization": f"Bearer {key}"},
)
r.raise_for_status()
data = r.json()
lines += data["lines"]
if page * data["per_page"] >= data["total"]:
break
page += 1
print(len(lines), "lines")Reference
Fields in a line
Each line carries the columns of TraCarta's standard airline ITC format that your company can see, plus in_gstr2b and document_url. Dates are YYYY-MM-DD; amounts are numbers in rupees.
transaction_idTransaction IDtextfinancial_yearFinancial Yeartexttransaction_typeTransaction Typetextclient_nameClient Nametextclient_gstnClient GSTNtextclient_gstn_state_codeClient GSTN State Codetextclient_place_of_supplyClient Place of Supplytextta_invoice_dateDate of Travel Agent InvoicedateitineraryItinerarytextcity_of_originCity of Origintextjourney_typeJourney Typetexttotal_fareTotal Farenumberpax_namePax Nametextclass_of_travelClass of Traveltextairline_iataAirline IATA Codetextairline_nameAirline NametexteticketAirline E-Ticket Numbertextairline_invoice_numberAirline Invoice Numbertextairline_invoice_dateDate of Airline Invoicedateairline_gstnAirline GST Numbertextlos_codeCode for Location of Supply - Airline ServicetextlosLocation of Supply - Airline ServicetexthsnHSN Code - Airline Servicetexttaxable_valueTaxable Value of Service - Airline Servicenumbertax_typeType of Taxtextgst_pctPercentage of GSTnumberigst_pctPercentage of IGST - Airline Servicenumberigst_amtIGST Amount - Airline Servicenumbercgst_pctPercentage of CGST - Airline Servicenumbercgst_amtCGST Amount - Airline Servicenumbersgst_pctPercentage of SGST - Airline Servicenumbersgst_amtSGST Amount - Airline Servicenumbertotal_igstTotal IGST Charged by Airlinesnumbertotal_cgstTotal CGST Charged by Airlinesnumbertotal_sgstTotal SGST Charged by Airlinesnumbergstr2b_statusReflected in GSTR-2Btextin_gstr2bReflected in GSTR-2B: true, false or nullbooleandocument_urlLink to the airline PDF, or null if still waitingurlReference
Errors
Clarion uses ordinary HTTP status codes. Errors come back as JSON with a plain-language error message you can show or log.
{
"error": "Too many requests. Wait a little and try again."
}Reference
Limits and keys
Over the limit you get 429 with a Retry-After header. For large pulls, use per_page=1000 and filter by financial year or dates rather than fetching everything every time.
Tools
Try it live
Send a real request to your Clarion account from this page. Your key isn't saved anywhere.
Paste your key, pick an endpoint and press Send. The real response from your Clarion account shows here.
Tools
Changelog
Questions about the API? Write to TraCarta support from the Help page in Clarion.