API Reference

1. Data Cleaning Endpoint

Description Cleans the dataset according to user-defined options, including handling missing values, detecting outliers, and removing duplicates.

Endpoint POST /cleaning

Request Format

Content-Type: application/json Authorization: Bearer <your-api-token>

1{
2   "dataset_url": "https://example.com/mydata.csv",
3   "cleaning_options": {
4      "handle_missing": "mean",
5      "detect_outliers": true,
6      "remove_duplicates": true
7   }
8}

Response Format

1{
2   "status": "success",
3   "cleaned_dataset_url": "https://preppydata.com/cleaned/mydata_cleaned.csv",
4   "summary": {
5      "rows_removed": 5,
6      "missing_values_handled": true,
7      "outliers_detected": 12
8   }
9}

1{
2   "status": "error",
3   "message": "Dataset URL is invalid or inaccessible."
4}

Usage Example

 1curl -X POST https://api.preppydata.com/v1/cleaning \
 2-H "Content-Type: application/json" \
 3-H "Authorization: Bearer YOUR_API_TOKEN" \
 4-d '{
 5   "dataset_url": "https://example.com/mydata.csv",
 6   "cleaning_options": {
 7      "handle_missing": "mean",
 8      "detect_outliers": true,
 9      "remove_duplicates": true
10   }
11}'

2. Feature Selection Endpoint

Description Selects the most important features from the dataset using a user-defined algorithm.

Endpoint POST /feature-selection

Request Format

Content-Type: application/json Authorization: Bearer <your-api-token>

1{
2   "dataset_url": "https://example.com/mydata.csv",
3   "selection_method": "random_forest",
4   "num_features": 5
5}

Response Format

1{
2   "status": "success",
3   "selected_features": ["feature_1", "feature_3", "feature_5", "feature_7", "feature_9"],
4   "dataset_url_with_selected_features": "https://preppydata.com/processed/mydata_selected.csv"
5}

1{
2   "status": "error",
3   "message": "Selection method is invalid or unsupported."
4}

Usage Example

1curl -X POST https://api.preppydata.com/v1/feature-selection \
2-H "Content-Type: application/json" \
3-H "Authorization: Bearer YOUR_API_TOKEN" \
4-d '{
5   "dataset_url": "https://example.com/mydata.csv",
6   "selection_method": "random_forest",
7   "num_features": 5
8}'

3. Encoding Endpoint

Description Converts categorical data into One-hot, Label, or Target encoding.

Endpoint POST /encoding

Request Format

Content-Type: application/json Authorization: Bearer <your-api-token>

1{
2   "dataset_url": "https://example.com/mydata.csv",
3   "encoding_type": "one_hot",
4   "columns_to_encode": ["column1", "column2"]
5}

Response Format

1{
2   "status": "success",
3   "encoded_dataset_url": "https://preppydata.com/processed/mydata_encoded.csv"
4}

1{
2   "status": "error",
3   "message": "Column names are invalid or missing in the dataset."
4}

Usage Example

1curl -X POST https://api.preppydata.com/v1/encoding \
2-H "Content-Type: application/json" \
3-H "Authorization: Bearer YOUR_API_TOKEN" \
4-d '{
5   "dataset_url": "https://example.com/mydata.csv",
6   "encoding_type": "one_hot",
7   "columns_to_encode": ["column1", "column2"]
8}'

Error Codes

Code

Message

Description

400

Bad Request

The request parameters are invalid or missing.

401

Unauthorized

The API token is invalid.

500

Internal Server Error

An unexpected error occurred on the server.