Network Resource

Access cellular networks to which Super SIMs can connect

A Network resource represents a cellular network to which Super SIMs can connect.

You can obtain a list of all available mobile operator networks, provided as an array of Network resources, from this endpoint:

https://supersim.api.korewireless.com/v1/Networks

To allow Super SIMs to connect to the cellular network that a Network resource represents, the Network resource must be included in a Network Access Profile resource's Networks subresource.

Network Identifiers

Each Network resource will have a sid property that is used by KORE as the primary identifier. This is a unique identifier to KORE. In the world of cellular connectivity, networks are often referred to by their MCC (mobile country code) and MNC (mobile network code). Networks often have multiple MCC-MNCs associated with it. You can look these up on various websites such as this one.

There have been many mergers, spin-offs, and rebrandings of mobile network operators around the world. A PLMN may therefore have many identifiers, i.e., multiple MCC and MNC pairings. A PLMN's trading name may no longer match the 'friendly name' which is used to identify it in a human-readable way to other PLMNs and which is recorded in a Network resource's friendly_name property.

If there is a specific mobile network operator you are looking for which may have a different name to the Network resource's friendly_name property, check if its MCC and MNC IDs are included among a Network resource's identifiers.

A Network resource's identifiers property is an array of objects that contain identifiers for all of the public land mobile networks (PLMNs) that are represented by a Network resource. Each object in the array will have these properties:

mcc

The Mobile Country Code (MCC) is the unique ID that identifies the mobile operator network's home country.

mnc

The Mobile Network Code (MNC) is the unique ID that identifies the mobile operator network.

API Authorization

Before you can make requests to this resource, you must have a valid bearer token. Review our API authorization guide to learn how to generate a token. Here's a curl example on how to define your access token in a header:

curl -X GET \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
'https://supersim.api.korewireless.com/v1/Sims'

The examples below do not show the required Authorization header due to a bug. We're working on fixing that. In the meantime, be sure to include that in all of your requests.

Fetch a Network Resource

Fetch a Network resource.

GEThttps://supersim.api.korewireless.com/v1/Networks/{Sid}

Authorization

Path parameters

Sid*string

The SID of the Network resource to fetch.

Pattern: ^HW[0-9a-fA-F]{32}$

Response

Headers

Body

sidnullable string

The unique string that we created to identify the Network resource.

Pattern: ^HW[0-9a-fA-F]{32}$

friendly_namenullable string

A human readable identifier of this resource.

urlnullable string (uri)

The absolute URL of the Network resource.

iso_countrynullable string

The ISO country code of the Network resource.

identifiersnullable array of any

Array of objects identifying the MCC-MNCs that are included in the Network resource.

Request

const response = await fetch('https://supersim.api.korewireless.com/v1/Networks/{Sid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "sid": "text",
  "friendly_name": "text",
  "url": "https://example.com",
  "iso_country": "text",
  "identifiers": []
}

Read Multiple Network Resources

Retrieve a list of Network resources.

GEThttps://supersim.api.korewireless.com/v1/Networks

Authorization

Query parameters

Response

Headers

Body

networksarray of supersim.v1.network (object)

metaobject

Request

const response = await fetch('https://supersim.api.korewireless.com/v1/Networks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "networks": [
    {
      "sid": "text",
      "friendly_name": "text",
      "url": "https://example.com",
      "iso_country": "text",
      "identifiers": []
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "text",
    "next_page_url": "https://example.com",
    "page": 0,
    "page_size": 0,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}

More Read Examples

Read Network resources

curl -X GET "https://supersim.api.korewireless.com/v1/Networks?PageSize=20" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

{
	"meta": {
	    "page": 0,
	    "page_size": 20,
	    "first_page_url": "https://supersim.api.korewireless.com/v1/Networks?Page=0&PageSize=20",
	    "previous_page_url": null,
	    "url": "https://supersim.api.korewireless.com/v1/Networks?Page=0&PageSize=20",
	    "key": "networks",
	    "next_page_url": "https://supersim.api.korewireless.com/v1/Networks?Page=1&PageSize=20&PageToken=NTUxXzE"
	},
	"networks": [
	    {
		"sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
		"friendly_name": "T-Mobile",
		"iso_country": "US",
		"identifiers": [
		    {
			"mcc": "310",
			"mnc": "490"
		],
		"url": "https://supersim.api.korewireless.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
	    }
	]
}

Read Network resources in a country

To filter down the list of networks to just those available in a given country, provide the ISO2 country code (e.g., "US" for the United States) as the IsoCountry query parameter.

curl -X GET "https://supersim.api.korewireless.com/v1/Networks?IsoCountry=US&PageSize=20" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

{
    "meta": {
        "page": 0,
        "page_size": 20,
        "first_page_url": "https://supersim.api.korewireless.com/v1/Networks?IsoCountry=US&&Page=0&PageSize=20",
        "previous_page_url": null,
        "url": "https://supersim.api.korewireless.com/v1/Networks?IsoCountry=US&&Page=0&PageSize=20",
        "key": "networks",
        "next_page_url": null
    },
    "networks": [
        {
            "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "friendly_name": "T-Mobile",
            "iso_country": "US",
            "identifiers": [
                {
                    "mcc": "310",
                    "mnc": "490"
                },
                {
                    "mcc": "310",
                    "mnc": "240"
                },
                {
                    "mcc": "310",
                    "mnc": "220"
                },
                {
                    "mcc": "310",
                    "mnc": "230"
                },
                {
                    "mcc": "310",
                    "mnc": "310"
                },
                {
                    "mcc": "310",
                    "mnc": "210"
                },
                {
                    "mcc": "310",
                    "mnc": "200"
                },
                {
                    "mcc": "310",
                    "mnc": "260"
                },
                {
                    "mcc": "310",
                    "mnc": "270"
                },
                {
                    "mcc": "310",
                    "mnc": "160"
                },
                {
                    "mcc": "310",
                    "mnc": "250"
                }
            ],
            "url": "https://supersim.api.korewireless.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        }
    ]
}

Read Network resources by MCC-MNC

You can use the a cellular network's MCC-MNC to search for a specific network. For example, one of AT&T US' MCC-MNCs is 310-410. You can use the Mcc and Mnc query parameters to search for the Network resource which represents AT&T US.

curl -X GET "https://supersim.api.korewireless.com/v1/Networks?Mcc=310&Mnc=410&PageSize=20" \
--header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

{
    "meta": {
        "page": 0,
        "page_size": 20,
        "first_page_url": "https://supersim.api.korewireless.com/v1/Networks?Mcc=310&Mnc=410&&Page=0&PageSize=20",
        "previous_page_url": null,
        "url": "https://supersim.api.korewireless.com/v1/Networks?Mcc=310&Mnc=410&&Page=0&PageSize=20",
        "key": "networks",
        "next_page_url": null
    },
    "networks": [
        {
            "sid": "HWd85b0262d6fc4c0b991bf8294596642e",
            "friendly_name": "AT&T",
            "iso_country": "US",
            "identifiers": [
                {
                    "mcc": "310",
                    "mnc": "170"
                },
                {
                    "mcc": "310",
                    "mnc": "280"
                },
                {
                    "mcc": "310",
                    "mnc": "410"
                },
                {
                    "mcc": "313",
                    "mnc": "100"
                },
                {
                    "mcc": "310",
                    "mnc": "380"
                },
                {
                    "mcc": "310",
                    "mnc": "030"
                },
                {
                    "mcc": "310",
                    "mnc": "150"
                }
            ],
            "url": "https://supersim.api.korewireless.com/v1/Networks/HWd85b0262d6fc4c0b991bf8294596642e"
        }
    ]
}

PreviousNetworkAccessProfile Network Subresource NextSettingsUpdates Resource

Last updated 1 month ago