Compare Excel Spreadsheets

Compute a diff between two spreadsheets. Supports both multipart/form-data file uploads and JSON with base64-encoded data URLs. Accepts .xlsx, .xls, and .csv files.

Columns are matched using headers and content, allowing renamed columns to remain paired.

post/excel

Request

  • Base URL: https://api.diffchecker.com/public
  • URL: https://api.diffchecker.com/public/excel
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in query parameter email

Query parameters

emailstring email

Your email address. Required if not using an API key.

input_type'json' | 'form' required

Specifies the request content-type.

  • form: multipart/form-data
  • json: application/json
diff_level'standard' | 'formulas'

Specifies whether you want to diff values by their formulas or standard values. Default is standard.

ignore_whitespace'true' | 'false'

Whether to ignore leading and trailing whitespace in the diff. Default is false.

ignore_case_changes'true' | 'false'

Whether to ignore case changes in the diff. Default is false.

hide_unchanged_rows'true' | 'false'

Whether to hide unchanged rows in the diff. Default is false.

hide_unchanged_columns'true' | 'false'

Whether to hide unchanged columns in the diff. Default is false.

Headers

Diffchecker-Version'1'

API version to serve the request with. Defaults to the newest version, currently 1, when omitted. An unsupported version is rejected with 400 UNSUPPORTED_API_VERSION. See Versioning and Deprecation in the getting started guide.

Request body

left_spreadsheetstring required

Data URL of the left spreadsheet (data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,...).

right_spreadsheetstring required

Data URL of the right spreadsheet.

left_sheet_namestring

The sheet name from the left spreadsheet to diff. If not provided, the first sheet will be used.

right_sheet_namestring

The sheet name from the right spreadsheet to diff. If not provided, the first sheet will be used.

left_header_rowinteger

The row number to use as the header from the left spreadsheet. If not provided, the first row will be used.

right_header_rowinteger

The row number to use as the header from the right spreadsheet. If not provided, the first row will be used.

Response

Diff computed successfully.

creditsUsedinteger required

Credits charged for the diff request.

Changes

No recorded changes to this operation across all 1 revision of this API.