Skip to main content
GET
/
reports
/
{report_id}
Get a report
curl --request GET \
  --url https://api.exchange.coinbase.com/reports/{report_id} \
  --header 'cb-access-key: <api-key>' \
  --header 'cb-access-passphrase: <api-key>' \
  --header 'cb-access-sign: <api-key>' \
  --header 'cb-access-timestamp: <api-key>'
{
  "created_at": "2019-07-25T22:14:00.410Z",
  "completed_at": "2019-07-25T22:14:01.332Z",
  "expires_at": "2019-08-01T22:14:00.410Z",
  "id": "66e2dc58-a11b-4ae7-af08-1b42cf8031ad",
  "type": "account",
  "status": "ready",
  "user_id": "5cf6e115aaf44503db300f1e",
  "file_url": "www.example.com",
  "params": {
    "start_date": "2019-06-25T22:13:48.592Z",
    "end_date": "2019-07-25T22:13:48.592Z",
    "format": "pdf",
    "product_id": "ALL",
    "account_id": "ALL",
    "profile_id": "8058d771-2d88-4f0f-ab6e-299c153d4308",
    "email": "user1@example.com",
    "user": {
      "created_at": "2019-06-04T21:22:32.226Z",
      "active_at": "2019-06-04T21:27:49.250Z",
      "id": "5cf6e115aaf44503db300f1e",
      "name": "User One",
      "email": "user1@example.com",
      "is_banned": false,
      "user_type": "individual",
      "fulfills_new_requirements": true,
      "oauth_client": "pro",
      "preferences": {
        "preferred_market": "BTC-USD",
        "margin_terms_completed_in_utc": "2019-06-13T23:40:17.752Z",
        "margin_tutorial_completed_in_utc": "2019-06-19T23:56:59.411Z"
      },
      "has_default": false
    },
    "new_york_state": false
  }
}
Once a report request has been accepted for processing, you can poll the report resource endpoint at /reports/{report_id} for its status. When status is ready, the final report is uploaded and available at {file_url}.

​
API Key Permissions

This endpoint requires either the “view” or “trade” permission.

Authorizations

​
cb-access-key
string
header
required
​
cb-access-passphrase
string
header
required
​
cb-access-sign
string
header
required
​
cb-access-timestamp
string
header
required

Path Parameters

​
report_id
string
required

Response

​
id
string
required
​
type
string
required
​
created_at
string<date-time>
required
​
completed_at
string<date-time>
required
​
expires_at
string<date-time>
required
​
status
enum<string>
default:pending
required
Available options:
pending,
creating,
ready,
failed
​
user_id
string
required
​
file_url
string
required
​
params
object
required
Example:
{
  "start_date": "2019-06-25T22:13:48.592Z",
  "end_date": "2019-07-25T22:13:48.592Z",
  "format": "pdf",
  "product_id": "ALL",
  "account_id": "ALL",
  "profile_id": "8058d771-2d88-4f0f-ab6e-299c153d4308",
  "email": "user1@example.com",
  "user": {
    "created_at": "2019-06-04T21:22:32.226Z",
    "active_at": "2019-06-04T21:27:49.250Z",
    "id": "5cf6e115aaf44503db300f1e",
    "name": "User One",
    "email": "user1@example.com",
    "is_banned": false,
    "user_type": "individual",
    "fulfills_new_requirements": true,
    "oauth_client": "pro",
    "preferences": {
      "preferred_market": "BTC-USD",
      "margin_terms_completed_in_utc": "2019-06-13T23:40:17.752Z",
      "margin_tutorial_completed_in_utc": "2019-06-19T23:56:59.411Z"
    },
    "has_default": false
  },
  "new_york_state": false
}
​
file_count
string<uint64>