> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.ntropy.com/documentation/api/bank-statements/get-bank-statement-result-v-3-bank-statements-id-results-get/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ntropy.com/_mcp/server. # Retrieve the extraction results GET https://api.ntropy.com/v3/bank_statements/{id}/results Return the extracted account information and associated transactions from a bank statement PDF. The results are accessible once the statement's status is `completed`. Reference: https://docs.ntropy.com/documentation/api/bank-statements/get-bank-statement-result-v-3-bank-statements-id-results-get ## Authentication - `X-Api-Key` header (required) — API Key authentication via header ## Request ### Path parameters - `id` (string, required) ## Response ### 200 Successful Response - `accounts` (list of BankStatementAccount, required) — List of accounts in the bank statement. ## Errors ### 404 Not Found Error Bank statement with the provided id not found. - `any` ### 422 Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ## Types ### BankStatementAccount - `transactions` (list of BankStatementTransaction, required) — List of transactions for this account. - `number` (string, optional, nullable) — The account number, if available. - `name` (string, optional, nullable) — The account name, if available. - `opening_balance` (double, optional, nullable) — The opening balance of the account for the statement period. - `closing_balance` (double, optional, nullable) — The closing balance of the account for the statement period. - `start_date` (date, optional, nullable) — The start date of the statement period. - `end_date` (date, optional, nullable) — The end date of the statement period. - `is_balance_reconciled` (boolean, optional, nullable) — Indicates whether the balance has been reconciled. - `total_incoming` (double, optional, nullable) — The sum of amounts of all incoming transactions. - `total_outgoing` (double, optional, nullable) — The sum of amounts of all outgoing transactions. ### ValidationError - `loc` (list of ValidationErrorLocItems, required) - `msg` (string, required) - `type` (string, required) ### BankStatementTransaction - `id` (string, required) — A unique identifier of the transaction - `description` (string, required) — The description string of the transaction - `date` (date, required) — The date that the transaction was posted. Uses ISO 8601 format (YYYY-MM-DD) - `amount` (double, required) — The amount of the transaction in the `currency`. Must be a positive value. For example, if the `currency` is USD, then it's the amount in dollars. - `entry_type` (enum, required) — The direction of the flow of the money from the perspective of the account holder. `outgoing` to represent money leaving the account, such as purchases or fees, while `incoming` represents money entering the account, such as income or refunds. - Allowed values: `incoming`, `outgoing` - `currency` (enum, required) — The currency of the transaction in ISO 4217 format - Allowed values: `EUR`, `AED`, `AFN`, `XCD`, `ALL`, `AMD`, `AOA`, `ARS`, `USD`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `XOF`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `INR`, `NOK`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `XAF`, `CHF`, `NZD`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `ANG`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `MAD`, `ERN`, `ETB`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HUF`, `IDR`, `ILS`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `ZAR`, `LYD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `XPF`, `NGN`, `NIO`, `NPR`, `OMR`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `YER`, `ZMW`, `ZWL`, `HRK` - `running_balance` (double, optional, nullable) — The account's balance when this transaction was performed - `page_number` (integer, optional, nullable) — The page number this transaction appears on, where 1 is the first page. ### ValidationErrorLocItems ## Examples ### Example_0 **Request** ```json {} ``` **Response** ```json { "accounts": [ { "transactions": [ { "id": "txn_001a2b3c", "description": "Payroll Deposit - ACME Corp", "date": "2023-01-05", "amount": 2000, "entry_type": "incoming", "currency": "USD", "running_balance": 3500.75, "page_number": 1 }, { "id": "txn_004d5e6f", "description": "Electricity Bill Payment", "date": "2023-01-10", "amount": 150.25, "entry_type": "outgoing", "currency": "USD", "running_balance": 3350.5, "page_number": 1 }, { "id": "txn_007g8h9i", "description": "Grocery Store Purchase", "date": "2023-01-15", "amount": 120, "entry_type": "outgoing", "currency": "USD", "running_balance": 3230.5, "page_number": 2 }, { "id": "txn_010j1k2l", "description": "Refund from Online Retailer", "date": "2023-01-20", "amount": 50, "entry_type": "incoming", "currency": "USD", "running_balance": 3280.5, "page_number": 2 }, { "id": "txn_013m4n5o", "description": "Monthly Rent Payment", "date": "2023-01-25", "amount": 2000, "entry_type": "outgoing", "currency": "USD", "running_balance": 1280.5, "page_number": 3 } ], "number": "123456789012", "name": "Primary Checking Account", "opening_balance": 1500.75, "closing_balance": 1200.5, "start_date": "2023-01-01", "end_date": "2023-01-31", "is_balance_reconciled": true, "total_incoming": 500, "total_outgoing": 800.25 } ] } ``` **SDK Code** ```python Example_0 import requests url = "https://api.ntropy.com/v3/bank_statements/id/results" payload = {} headers = { "X-Api-Key": "", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Example_0 const url = 'https://api.ntropy.com/v3/bank_statements/id/results'; const options = { method: 'GET', headers: {'X-Api-Key': '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Example_0 package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.ntropy.com/v3/bank_statements/id/results" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("X-Api-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Example_0 require 'uri' require 'net/http' url = URI("https://api.ntropy.com/v3/bank_statements/id/results") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Api-Key"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java Example_0 import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.ntropy.com/v3/bank_statements/id/results") .header("X-Api-Key", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php Example_0 request('GET', 'https://api.ntropy.com/v3/bank_statements/id/results', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'X-Api-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp Example_0 using RestSharp; var client = new RestClient("https://api.ntropy.com/v3/bank_statements/id/results"); var request = new RestRequest(Method.GET); request.AddHeader("X-Api-Key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Example_0 import Foundation let headers = [ "X-Api-Key": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.ntropy.com/v3/bank_statements/id/results")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### cURL **SDK Code** ```python Python SDK from ntropy_sdk import SDK sdk = SDK("cd1H...Wmhl") bs = sdk.bank_statements.get("7f8dceac-2848-472d-b5c3-55cdbaf35a9b") results = sdk.bank_statements.wait_for_results("7f8dceac-2848-472d-b5c3-55cdbaf35a9b") ``` ```javascript cURL const url = 'https://api.ntropy.com/v3/bank_statements/:id/results'; const options = {method: 'GET', headers: {'X-Api-Key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go cURL package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.ntropy.com/v3/bank_statements/:id/results" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Api-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby cURL require 'uri' require 'net/http' url = URI("https://api.ntropy.com/v3/bank_statements/:id/results") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Api-Key"] = '' response = http.request(request) puts response.read_body ``` ```java cURL import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.ntropy.com/v3/bank_statements/:id/results") .header("X-Api-Key", "") .asString(); ``` ```php cURL request('GET', 'https://api.ntropy.com/v3/bank_statements/:id/results', [ 'headers' => [ 'X-Api-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp cURL using RestSharp; var client = new RestClient("https://api.ntropy.com/v3/bank_statements/:id/results"); var request = new RestRequest(Method.GET); request.AddHeader("X-Api-Key", ""); IRestResponse response = client.Execute(request); ``` ```swift cURL import Foundation let headers = ["X-Api-Key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.ntropy.com/v3/bank_statements/:id/results")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```