# API quickstart guide

Follow this guide to make your first Shippo API call. In this guide, you will learn how to create an address using the Shippo API.

## ![](/assets/step1.14ee6260337a0b326de06f1173e3703f933b52790e666cd390788635d3e7e0a6.9c1bb791.svg) Generate your API Token

Follow the [Authentication guide](/docs/guides_general/authentication) to generate your API Token.

Note
When learning about and testing the Shippo API, we recommend using the [test token](/docs/guides_general/testing).
Using your test token means all the calls you make to the Shippo API are free.

## ![](/assets/step2.37831ee18f1f0290fe49fb6b512319f7a374b18f4063f0302fe35b4afcd9816b.9c1bb791.svg) Install the client library for your language


```shell cURL
# No library needed for cURL
```


```python Python
pip install shippo
```


```php PHP
// Follow the steps in 
// https://github.com/goshippo/shippo-php-client
```


```javascript Node.js
npm install shippo
```


```java Java
// Java
npm install shippo
```


```cs C#
dotnet add package Shippo
```


```other Other libraries
// For a full list of supported libraries, review our client libraries page
// https://docs.goshippo.com/docs/guides_general/clientlibraries/
```

See our [client libraries](/docs/guides_general/clientlibraries) page for more details.

## ![](/assets/step3.882dd6eb157abc25c1f2895637ba8769f3b55aa52288a40e94bd0d9550a670c5.9c1bb791.svg) Make your first API call

To make sure everything is working, make a simple call to create a new address in your Shippo account.

You must replace `<API_TOKEN>` with the token you copied from [Step 1](#generate-your-api-token).


```shell cURL
curl https://api.goshippo.com/addresses/ \
   -H "Authorization: ShippoToken <API_TOKEN>" \
   -d name="Shawn Ippotle" \
   -d company="Shippo" \
   -d street1="215 Clayton St." \
   -d street2="" \
   -d city="San Francisco" \
   -d state="CA" \
   -d zip=94117 \
   -d country="US" \
   -d phone="+1 555 341 9393" \
   -d email="shippotle@shippo.com"\
   -d is_residential=True\
   -d metadata="Customer ID 123456"
```


```python Python
import shippo
from shippo.models import components

shippo_sdk = shippo.Shippo(api_key_header="<API_Token>")

shippo_sdk.addresses.create(
    components.AddressCreateRequest(
        name="Shawn Ippotle",
        company="Shippo",
        street1="215 Clayton St.",
        city="San Francisco",
        state="CA",
        zip="94117",
        country="US", # iso2 country code
        phone="+1 555 341 9393",
        email="shippotle@shippo.com"
    )
)
```


```php PHP
require_once('lib/Shippo.php');
Shippo::setApiKey("<API_TOKEN>");

// Create address object
$fromAddress = Shippo_Address::create( array(
    "name" => "Shawn Ippotle",
    "company" => "Shippo",
    "street1" => "215 Clayton St.",
    "city" => "San Francisco",
    "state" => "CA",
    "zip" => "94117",
    "country" => "US",
    "phone" => "+1 555 341 9393",
    "email" => "shippotle@shippo.com" 
));
```


```typescript TypeScript
// Create address object
const shippo = new Shippo({apiKeyHeader: '<API_TOKEN>'});
const addressFrom = await shippo.addresses.create({
    name: "Shawn Ippotle",
    company: "Shippo",
    street1: "215 Clayton St.",
    city: "San Francisco",
    state: "CA",
    zip: "94117",
    country: "US", // iso2 country code
    phone: "+1 555 341 9393",
    email: "shippotle@shippo.com",
});
```


```java Java
Shippo.setApiKey('<API_TOKEN>');

HashMap<String, Object> addressMap = new HashMap<String, Object>();
addressMap.put("name", "Mr. Hippo");
addressMap.put("company", "Shippo");
addressMap.put("street1", "215 Clayton St.");
addressMap.put("city", "San Francisco");
addressMap.put("state", "CA");
addressMap.put("zip", "94117");
addressMap.put("country", "US");
addressMap.put("phone", "+1 555 341 9393");
addressMap.put("email", "support@goshipppo.com");

Address createAddress = Address.create(addressMap);
```


```cs C#
using Shippo;
using Shippo.Models.Components;
ShippoSDK sdk = new ShippoSDK(apiKeyHeader: "<API_TOKEN>");
Address address = await sdk.Addresses.CreateAsync(
    new AddressCreateRequest()
    {
        Name = "Shawn Ippotle",
        Company = "Shippo",
        Street1 = "215 Clayton St.",
        City = "San Francisco",
        State = "CA",
        Zip = "94117",
        Country = "US",
        Phone = "+1 555 341 9393",
        Email = "shippotle@shippo.com",
    }
);
```


```other Other libraries
// For a full list of supported libraries, review our client libraries page
// https://docs.goshippo.com/docs/guides_general/clientlibraries/
```

If your request to create a new address was a success, the response should look like the following.
If you don't get a response like this, check your code and make sure your API token is correct.


```json
{
   "is_complete": true,
   "object_created":"2022-07-09T02:19:13.174Z",
   "object_updated":"2022-07-09T02:19:13.174Z",
   "object_id":"d799c2679e644279b59fe661ac8fa488",
   "object_owner":"shippotle@shippo.com",
   "validation_results": {},
   "name":"Shawn Ippotle",
   "company":"Shippo",
   "street_no": "",
   "street1":"215 Clayton St.",
   "street2":"",
   "street3":"",
   "city":"San Francisco",
   "state":"CA",
   "zip":"94117",
   "country":"US",
   "longitude": null,
   "latitude": null,
   "phone":"15553419393",
   "email":"shippotle@shippo.com",
   "is_residential":true,
   "metadata":"Customer ID 123456"
}
```

## ![](/assets/step4.3e238973da1bfa25a515a0ceb0fa4ba0aff3b95a0b56ae4973003052290131dd.9c1bb791.svg) Next steps

You now know how to make API calls using the Shippo API. Your next step is to create your [first shipping label](/docs/guides_general/generate_shipping_label).

You can also start exploring our [API reference](/shippoapi/public-api/overview) to learn about all the Shippo API features.