Imports API
Import geospatial files into your data warehouse.
Letting CARTO detect the schema, or setting it yourself
Endpoints
Imports a geospatial file from a URL into a table in your data warehouse.
The job runs asynchronously — poll
GET /v3/imports/{jobId} with the returned
jobId.
By default CARTO guesses the schema of the file. To set it yourself, call
POST /v3/imports/preview first, then pass
autoguessing: false together with the schema you want.
Each account can run 5 import jobs concurrently.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
Name of the connection to import through.
Public URL of the file to import.
Fully qualified name of the table to create.
Replace the destination table if it already exists.
falseLet CARTO detect the schema. Set to false to import with the schema
you provide.
trueValidate the import without writing anything. Can't be combined with
overwrite.
falseSkip rows that fail to parse. Defaults to the value of autoguessing.
How many bad rows to tolerate. Defaults to 1000 when autoguessing is
on, 0 otherwise.
Wrap geometries that cross the antimeridian.
falseKeep the source coordinate reference system instead of reprojecting to EPSG:4326.
falseThe import job was created.
success, failure and cancelled are final states.
The request is malformed or a parameter failed validation.
The token is missing, malformed or expired.
The token doesn't grant access to this resource.
The connection doesn't exist.
You already have 5 import jobs running. Wait for one to finish.
Lists import jobs. By default only pending and running jobs are
returned — pass status to widen the search.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
Comma-separated list of statuses to return. Defaults to
pending,running.
success,failureOnly return jobs created after this date.
The import jobs.
The URL the data was imported from.
Only returned by the list endpoint.
success, failure and cancelled are final states.
Empty string when the job hasn't failed. Otherwise a message or a structured error object.
The token is missing, malformed or expired.
You went over the rate limit for this API.
Inspects a file and returns the schema CARTO would use to import it, without importing anything.
Use the returned columns as a starting point for the schema of a
manual import.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
Name of the connection to import through.
Public URL of the file to inspect.
The detected schema.
The request is malformed or a parameter failed validation.
The token is missing, malformed or expired.
The token doesn't grant access to this resource.
The connection doesn't exist.
You went over the rate limit for this API.
Returns the current state of an import job. Poll this until status is
success, failure or cancelled.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
The job identifier returned when the job was created.
The import job.
The URL the data was imported from.
Only returned by the list endpoint.
success, failure and cancelled are final states.
Empty string when the job hasn't failed. Otherwise a message or a structured error object.
The job belongs to another user.
The resource doesn't exist.
You went over the rate limit for this API.
Cancels an import job that is still pending or running. Cancelling a
job that already finished returns 400.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
The cancelled job.
The URL the data was imported from.
Only returned by the list endpoint.
success, failure and cancelled are final states.
Empty string when the job hasn't failed. Otherwise a message or a structured error object.
The job already finished and can't be cancelled.
The token is missing, malformed or expired.
The job belongs to another user.
The resource doesn't exist.
You went over the rate limit for this API.
Last updated
Was this helpful?
